@royalschedule/maps 4.0.0 → 4.0.2

package/dist/common/types.d.ts

@@ -3,10 +3,17 @@ import { Moment } from "moment";
 
 //#region src/common/types.d.ts
 type DateType = Moment | string | Date;
+/**
+ * T1 | T2 | ... => T1 & T2 & ...
+ */
 type Intersect<T> = (T extends any ? ((x: T) => 0) : never) extends ((x: infer R) => 0) ? R : never;
 type BaseOptions = {
   idKey?: IdKey;
 };
+/**
+ * The interface required for the "from" mapping functions.
+ */
+
 //#endregion
 export { BaseOptions, DateType, Intersect };
 //# sourceMappingURL=types.d.ts.map

package/dist/core/to/util.d.ts

@@ -1,10 +1,14 @@
-import { Vertex } from "../types/common/index.js";
 import { Intersect } from "../../common/types.js";
+import { Vertex } from "../types/common/index.js";
 
 //#region src/core/to/util.d.ts
 
 declare const keys: readonly ["_id", "createdAt", "updatedAt", "belongsTo", "lastModifiedBy", "CONTEXT"];
 type InternalKeysOmitted<V extends Vertex> = Omit<Intersect<V>, typeof keys[number]>;
+/**
+ * Returns a copy of the vertex with internal keys omitted, such as `_id`, `createdAt`, `updatedAt`, etc.
+ * The output type also omits all edges for ease of use.
+ */
 //#endregion
 export { InternalKeysOmitted };
 //# sourceMappingURL=util.d.ts.map

package/dist/core/types/common/index.d.ts

@@ -1,3 +1,4 @@
+import { DateType } from "../../../common/types.js";
 import { Types } from "mongoose";
 
 //#region src/core/types/common/index.d.ts
@@ -8,8 +9,8 @@ type Vertex = ({
 } | {
   id: ID;
 }) & {
-  createdAt?: string;
-  updatedAt?: string;
+  createdAt?: DateType;
+  updatedAt?: DateType;
   lastModifiedBy?: unknown;
   ids?: ID;
 };

package/dist/core/types/common/intervals.d.ts

@@ -6,7 +6,13 @@ type Interval<T = DateType> = {
   end: T;
 };
 interface AllowedInterval<T = DateType> extends Interval<T> {
+  /**
+   * @deprecated IS THIS REALLY OPTIONAL? ALSO, IS THIS USED ANYWHERE?
+   */
   day?: number;
+  /**
+   * @deprecated WHAT IS THE VALUE OF THE STRING!?
+   */
   type?: string;
 }
 //#endregion

package/dist/core/types/common/maximum-schedule-span.d.ts

@@ -1,6 +1,17 @@
 //#region src/core/types/common/maximum-schedule-span.d.ts
+/**
+ * The maximum number of minutes a schedule is allowed to span over a day and week
+ */
 type MaximumScheduleSpan = {
+  /**
+   * The maximum number of minutes a schedule is allowed to span over a day.
+   * The daily schedule span is the duration between the start of the first event and the end of the last event that day.
+   */
   daily?: number | null;
+  /**
+   * The maximum number of minutes a schedule is allowed to span over a week.
+   * The weekly schedule span is the sum of the daily schedule spans for each day of the week.
+   */
   weekly?: number | null;
 };
 //#endregion

package/dist/core/types/common/planned-schedule-duration.d.ts

@@ -1,5 +1,11 @@
 //#region src/core/types/common/planned-schedule-duration.d.ts
+/**
+ * The planned/expected total weekly minutes of schedule events assigned to a teacher
+ */
 type PlannedScheduledDuration = {
+  /**
+   * The planned/expected total weekly minutes of schedule events assigned to a teacher
+   */
   weekly?: number | null;
 };
 //#endregion

package/dist/core/types/courses.d.ts

@@ -1,5 +1,5 @@
-import { AvailableLocation, GroupReference, PersonReference, Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { AvailableLocation, GroupReference, PersonReference, Vertex } from "./common/index.js";
 import { BreakLength } from "./common/break-lengths.js";
 import { AllowedInterval } from "./common/intervals.js";
 import { Day } from "./common/days.js";
@@ -48,7 +48,9 @@ type Course = Vertex & {
   overlapSpecies?: OverlapGroup | null;
   plannedDuration?: string;
   tags?: Tag[];
+  /** @deprecated replaced by plannedDuration? */
   minutesPerWeek?: number;
+  /** @deprecated replaced by plannedDuration? */
   expectedTotalHours?: number;
 };
 //#endregion

package/dist/core/types/division-settings.d.ts

@@ -1,5 +1,5 @@
-import { Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { Vertex } from "./common/index.js";
 import { RootInterval } from "./root-intervals.js";
 import { MaximumScheduleSpan } from "./common/maximum-schedule-span.js";
 import { PlannedScheduledDuration } from "./common/planned-schedule-duration.js";
@@ -44,7 +44,9 @@ type DivisionSettings = Vertex & {
   eventTime?: number;
   eventTimeActive?: boolean;
   defaultRootInterval?: RootInterval;
+  /** @deprecated replaced by defaultMaximumScheduleSpan */
   defaultMaxNumWorkingHours?: number | null;
+  /** @deprecated replaced by defaultMaximumScheduleSpan */
   defaultMaxNumDailyWorkingHours?: number | null;
 };
 //#endregion

package/dist/core/types/divisions.d.ts

@@ -1,5 +1,5 @@
-import { Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { Vertex } from "./common/index.js";
 import { DivisionSettings } from "./division-settings.js";
 import { Meta } from "./common/meta.js";
 
@@ -8,7 +8,7 @@ import { Meta } from "./common/meta.js";
 type StepGuideProgress = {
   checked: string[];
   completed: boolean;
-  updatedAt?: string;
+  updatedAt?: DateType;
 };
 type Division = Vertex & {
   settings?: DivisionSettings;

package/dist/core/types/events.d.ts

@@ -1,5 +1,5 @@
-import { AvailableLocation, GroupReference, PersonReference, Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { AvailableLocation, GroupReference, PersonReference, Vertex } from "./common/index.js";
 import { BreakLength } from "./common/break-lengths.js";
 import { AllowedInterval } from "./common/intervals.js";
 import { Day } from "./common/days.js";

package/dist/core/types/exceptions.d.ts

@@ -1,5 +1,5 @@
-import { Coalesced, Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { Coalesced, Vertex } from "./common/index.js";
 import { Group } from "./groups.js";
 import { Person } from "./persons.js";
 import { Teacher } from "./teachers.js";

package/dist/core/types/groups.d.ts

@@ -31,7 +31,9 @@ type Group = Vertex & {
   rootInterval?: RootInterval;
   days?: Day[];
   tags?: Tag[];
+  /** @deprecated replaced by maximumScheduleSpan */
   maxNumWorkingHours?: number | boolean;
+  /** @deprecated replaced by maximumScheduleSpan */
   maxNumDailyWorkingHours?: number | number[] | boolean;
 };
 //#endregion

package/dist/core/types/locked-times.d.ts

@@ -1,5 +1,5 @@
-import { Coalesced, Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { Coalesced, Vertex } from "./common/index.js";
 import { AllowedInterval } from "./common/intervals.js";
 import { Day } from "./common/days.js";
 import { Tag } from "./common/tag.js";
@@ -11,7 +11,7 @@ import { Course } from "./courses.js";
 import { Division } from "./divisions.js";
 
 //#region src/core/types/locked-times.d.ts
-type Type = 'LUNCH' | 'COMPLEMENTARY_TIME';
+type Type = /* 'ANY' | */'LUNCH' | 'COMPLEMENTARY_TIME';
 type LockedTime = Vertex & {
   belongsTo?: Division;
   displayName?: string;

package/dist/core/types/persons.d.ts

@@ -1,5 +1,5 @@
-import { Vertex } from "./common/index.js";
 import { DateType } from "../../common/types.js";
+import { Vertex } from "./common/index.js";
 import { Tag } from "./common/tag.js";
 import { Group } from "./groups.js";
 import { LockedTime } from "./locked-times.js";

package/dist/core/types/teachers.d.ts

@@ -31,7 +31,9 @@ type Teacher = Vertex & {
   signature?: string;
   rank?: number;
   tags?: Tag[];
+  /** @deprecated replaced by maximumScheduleSpan */
   maxNumWorkingHours?: number | boolean;
+  /** @deprecated replaced by maximumScheduleSpan */
   maxNumDailyWorkingHours?: number | number[] | boolean;
 };
 //#endregion

package/dist/core/vertex-mapping.d.ts

@@ -42,8 +42,17 @@ type _Mixed<T extends Vertex, Depth extends SupportedDepths = MaxDepth, IgnoreIn
   depth: Depth;
   ignoreInternalId: IgnoreInternalId;
 }> };
+/**
+ * Given a vertex type, this will return a new type where all references to other vertices are replaced with their mixed type.
+ */
 type Mixed<T extends Vertex> = _Mixed<T>;
+/**
+ * Given a vertex type, this will return a new type where all references to other vertices are replaced with their mixed type, but without the internal id (`_id` and `id`)
+ */
 type MixedWithoutInternalId<T extends Vertex> = Omit<_Mixed<T, MaxDepth, true>, InternalIdKey>;
+/**
+ * Given a vertex type, this will return a new type where all references to other vertices are replaced with their serialized type at the specified depth.
+ */
 type Serialized<T extends Vertex, DepthIndex extends SupportedDepths = 0> = Vertex & { [K in keyof T]: TransformGeneral<T[K], {
   type: 'serialized';
   depth: DepthIndex;
@@ -51,6 +60,10 @@ type Serialized<T extends Vertex, DepthIndex extends SupportedDepths = 0> = Vert
   type: 'serialized';
   depth: DepthIndex;
 }> };
+/**
+ * Given a object that contains entries of vertices or arrays of vertices, this will return a new type where all references to other vertices are replaced with their serialized type.
+ */
+
 //#endregion
 export { Mixed, MixedWithoutInternalId, Serialized };
 //# sourceMappingURL=vertex-mapping.d.ts.map

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { Types as Types$14 } from "./Skola24/txt/types/index.js";
+import { Types as Types$15 } from "./Skola24/txt/types/index.js";
 import { Types as Types$2 } from "./core/types/index.js";
 import { CoreMap } from "./core/index.js";
-import { Types as Types$13 } from "./Skola24/mdb/types/index.js";
+import { Types as Types$14 } from "./Skola24/mdb/types/index.js";
 import { Types as Types$3 } from "./Excel/v1/types/index.js";
 import { Types as Types$4 } from "./Excel/v2/types/index.js";
-import { Types as Types$10 } from "./SchoolSoft/file/types/index.js";
-import { Types as Types$9 } from "./SchoolSoft/api/types/index.js";
+import { Types as Types$11 } from "./SchoolSoft/file/types/index.js";
+import { Types as Types$10 } from "./SchoolSoft/api/types/index.js";
 import { SchoolSoftMap } from "./SchoolSoft/index.js";
 import { Types as Types$7 } from "./PlanDigital/types/index.js";
 import { PlanDigitalMap } from "./PlanDigital/index.js";
@@ -21,13 +21,15 @@ import { identify } from "./identify/index.js";
 import { Types as Types$6 } from "./InfoMentor/types/index.js";
 import { InfoMentorMap } from "./InfoMentor/index.js";
 import { Skola24Map } from "./Skola24/index.js";
-import { Types as Types$12 } from "./sdui/types/index.js";
+import { Types as Types$13 } from "./sdui/types/index.js";
 import { SduiMap } from "./sdui/index.js";
+import { Types as Types$9 } from "./SS12000/types/index.js";
+import { SS12000Map } from "./SS12000/index.js";
 import { vKlassMap } from "./vKlass/index.js";
 import { ExcelMap } from "./Excel/index.js";
-import { Types as Types$11 } from "./Schoolity/txt/types/index.js";
+import { Types as Types$12 } from "./Schoolity/txt/types/index.js";
 import { SchoolityMap } from "./Schoolity/index.js";
 import { QuiculumMap } from "./Quiculum/index.js";
 import { Types } from "./Additio/types/index.js";
 import { AdditioMap } from "./Additio/index.js";
-export { AdditioMap, Types as AdditioTypes, AdmentumMap, Types$1 as AdmentumTypes, CoreMap, Types$2 as CoreTypes, ExcelMap, Types$3 as ExcelV1Types, Types$4 as ExcelV2Types, IdentifiedMaps, IdunSoftMap, Types$5 as IdunSoftTypes, InfoMentorMap, Types$6 as InfoMentorTypes, MapInstance, MapName, PlanDigitalMap, Types$7 as PlanDigitalTypes, QuiculumMap, RSMap, Types$8 as RSTypes, Types$9 as SchoolSoftApiTypes, Types$10 as SchoolSoftFileTypes, SchoolSoftMap, SchoolityMap, Types$11 as SchoolityTXTTypes, SduiMap, Types$12 as SduiTypes, Types$13 as Skola24MDBTypes, Skola24Map, Types$14 as Skola24TXTTypes, identify, maps, vKlassMap };
+export { AdditioMap, Types as AdditioTypes, AdmentumMap, Types$1 as AdmentumTypes, CoreMap, Types$2 as CoreTypes, ExcelMap, Types$3 as ExcelV1Types, Types$4 as ExcelV2Types, IdentifiedMaps, IdunSoftMap, Types$5 as IdunSoftTypes, InfoMentorMap, Types$6 as InfoMentorTypes, MapInstance, MapName, PlanDigitalMap, Types$7 as PlanDigitalTypes, QuiculumMap, RSMap, Types$8 as RSTypes, SS12000Map, Types$9 as SS12000Types, Types$10 as SchoolSoftApiTypes, Types$11 as SchoolSoftFileTypes, SchoolSoftMap, SchoolityMap, Types$12 as SchoolityTXTTypes, SduiMap, Types$13 as SduiTypes, Types$14 as Skola24MDBTypes, Skola24Map, Types$15 as Skola24TXTTypes, identify, maps, vKlassMap };

package/dist/index.js

@@ -10,9 +10,10 @@ import { maps } from "./identify/constants/index.js";
 import { identify } from "./identify/index.js";
 import { InfoMentorMap } from "./InfoMentor/index.js";
 import { SduiMap } from "./sdui/index.js";
+import { SS12000Map } from "./SS12000/index.js";
 import { vKlassMap } from "./vKlass/index.js";
 import { SchoolityMap } from "./Schoolity/index.js";
 import { QuiculumMap } from "./Quiculum/index.js";
 import { AdditioMap } from "./Additio/index.js";
 
-export { AdditioMap, AdmentumMap, CoreMap, ExcelMap, IdunSoftMap, InfoMentorMap, PlanDigitalMap, QuiculumMap, RSMap, SchoolSoftMap, SchoolityMap, SduiMap, Skola24Map, identify, maps, vKlassMap };
+export { AdditioMap, AdmentumMap, CoreMap, ExcelMap, IdunSoftMap, InfoMentorMap, PlanDigitalMap, QuiculumMap, RSMap, SS12000Map, SchoolSoftMap, SchoolityMap, SduiMap, Skola24Map, identify, maps, vKlassMap };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@royalschedule/maps",
   "description": "",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",