@eduware/oneroster 1.2.3 → 1.2.5

package/dist/esm/models/shared/enums.js

@@ -0,0 +1,462 @@
+/**
+ * OneRoster Specification Enums
+ *
+ * This file contains all enumerated vocabulary terms defined in the
+ * 1EdTech OneRoster v1.2 specification. These enums are shared across
+ * all operations to ensure consistency and reduce code duplication.
+ *
+ * @see https://www.imsglobal.org/oneroster-v12-final-specification
+ */
+import * as z from 'zod';
+// =============================================================================
+// Table 6.3.2 - BaseStatusEnum
+// =============================================================================
+/**
+ * Status of a OneRoster record.
+ *
+ * @remarks
+ * - `active` - An active record
+ * - `tobedeleted` - Denotes that it is safe to delete the record
+ */
+export const Status = {
+    /** An active record */
+    Active: 'active',
+    /** Denotes that it is safe to delete the record */
+    ToBeDeleted: 'tobedeleted',
+};
+/** @internal */
+export const Status$inboundSchema = z.nativeEnum(Status);
+/** @internal */
+export const Status$outboundSchema = Status$inboundSchema;
+// =============================================================================
+// Table 6.3.11 - RoleTypeEnum
+// =============================================================================
+/**
+ * Type of role assignment (primary or secondary).
+ *
+ * @remarks
+ * - `primary` - Denotes that this is the primary role within the associated org.
+ *   Only one role can be primary for each org.
+ * - `secondary` - Denotes this is a secondary role within the associated org
+ *   i.e. some other role is the primary.
+ */
+export const RoleType = {
+    /** Denotes that this is the primary role within the associated org */
+    Primary: 'primary',
+    /** Denotes this is a secondary role within the associated org */
+    Secondary: 'secondary',
+};
+/** @internal */
+export const RoleType$inboundSchema = z.nativeEnum(RoleType);
+/** @internal */
+export const RoleType$outboundSchema = RoleType$inboundSchema;
+// =============================================================================
+// Table 6.3.12 - RoleEnum (User Roles)
+// =============================================================================
+/**
+ * User role types in OneRoster.
+ *
+ * @remarks
+ * Defines all possible roles a user can have within an organization.
+ */
+export const UserRole = {
+    /** Someone who has administrative responsibility */
+    Administrator: 'administrator',
+    /** A classroom aide */
+    Aide: 'aide',
+    /** A school counselor */
+    Counselor: 'counselor',
+    /** A district-level administrator */
+    DistrictAdministrator: 'districtAdministrator',
+    /** A guardian of a student */
+    Guardian: 'guardian',
+    /** A parent of a student */
+    Parent: 'parent',
+    /** A school principal */
+    Principal: 'principal',
+    /** An exam proctor */
+    Proctor: 'proctor',
+    /** A relative of a student */
+    Relative: 'relative',
+    /** A site-level administrator */
+    SiteAdministrator: 'siteAdministrator',
+    /** A student at an organization */
+    Student: 'student',
+    /** A system-level administrator */
+    SystemAdministrator: 'systemAdministrator',
+    /** A teacher at an organization */
+    Teacher: 'teacher',
+};
+/** @internal */
+export const UserRole$inboundSchema = z.nativeEnum(UserRole);
+/** @internal */
+export const UserRole$outboundSchema = UserRole$inboundSchema;
+// =============================================================================
+// Table 6.3.6 - EnrolRoleEnum (Enrollment Roles)
+// =============================================================================
+/**
+ * Enrollment role types.
+ *
+ * @remarks
+ * Defines the roles that can be assigned in an enrollment record.
+ * This is a subset of UserRole used specifically for class enrollments.
+ */
+export const EnrollmentRole = {
+    /** Someone who has administrative responsibility for the Class */
+    Administrator: 'administrator',
+    /** Exam proctor */
+    Proctor: 'proctor',
+    /** A student at an organization e.g. School */
+    Student: 'student',
+    /** A Teacher at an organization e.g. School */
+    Teacher: 'teacher',
+};
+/** @internal */
+export const EnrollmentRole$inboundSchema = z.nativeEnum(EnrollmentRole);
+/** @internal */
+export const EnrollmentRole$outboundSchema = EnrollmentRole$inboundSchema;
+// =============================================================================
+// Table 6.3.13 - SessionTypeEnum
+// =============================================================================
+/**
+ * Academic session types.
+ *
+ * @remarks
+ * Defines the types of academic sessions/periods.
+ */
+export const SessionType = {
+    /** Denotes a period over which some grade/result is to be awarded */
+    GradingPeriod: 'gradingPeriod',
+    /** Denotes the school year */
+    SchoolYear: 'schoolYear',
+    /** Denotes a semester period. Typically there are two semesters per schoolYear */
+    Semester: 'semester',
+    /** Denotes a term period. Typically there are three terms per schoolYear */
+    Term: 'term',
+};
+/** @internal */
+export const SessionType$inboundSchema = z.nativeEnum(SessionType);
+/** @internal */
+export const SessionType$outboundSchema = SessionType$inboundSchema;
+// =============================================================================
+// Table 6.3.4 - ClassTypeEnum
+// =============================================================================
+/**
+ * Class types.
+ *
+ * @remarks
+ * Defines the types of classes.
+ */
+export const ClassType = {
+    /** The homeroom (form) assigned to the class */
+    Homeroom: 'homeroom',
+    /** The class as assigned in the timetable */
+    Scheduled: 'scheduled',
+};
+/** @internal */
+export const ClassType$inboundSchema = z.nativeEnum(ClassType);
+/** @internal */
+export const ClassType$outboundSchema = ClassType$inboundSchema;
+// =============================================================================
+// Table 6.3.9 - OrgTypeEnum
+// =============================================================================
+/**
+ * Organization types.
+ *
+ * @remarks
+ * Defines the types of organizations in the education hierarchy.
+ */
+export const OrgType = {
+    /** Denotes a department. A department may be a subset in a school or a set of schools */
+    Department: 'department',
+    /** Denotes a school district */
+    District: 'district',
+    /** Denotes a local organization. V1.0 instances used this value to identify districts */
+    Local: 'local',
+    /** Denotes a national level organization */
+    National: 'national',
+    /** Denotes a school. This is the unit of assignment for classes and enrollments */
+    School: 'school',
+    /** Denotes a state level organization */
+    State: 'state',
+};
+/** @internal */
+export const OrgType$inboundSchema = z.nativeEnum(OrgType);
+/** @internal */
+export const OrgType$outboundSchema = OrgType$inboundSchema;
+// =============================================================================
+// Table 6.3.7 - GenderEnum
+// =============================================================================
+/**
+ * Gender values.
+ *
+ * @remarks
+ * Defines the gender values for demographics.
+ */
+export const Gender = {
+    /** Gender of Female */
+    Female: 'female',
+    /** Gender of Male */
+    Male: 'male',
+    /** A gender that is known but which is not either Male or Female. Value added in OR 1.2 */
+    Other: 'other',
+    /** Unspecified as no data entry for this field has been made. Value added in OR 1.2 */
+    Unspecified: 'unspecified',
+};
+/** @internal */
+export const Gender$inboundSchema = z.nativeEnum(Gender);
+/** @internal */
+export const Gender$outboundSchema = Gender$inboundSchema;
+// =============================================================================
+// Table 6.3.14 - TrueFalseEnum
+// =============================================================================
+/**
+ * Boolean string values.
+ *
+ * @remarks
+ * OneRoster uses string representations of boolean values.
+ */
+export const TrueFalse = {
+    /** Requires the boolean value to be given as 'false' */
+    False: 'false',
+    /** Requires the boolean value to be given as 'true' */
+    True: 'true',
+};
+/** @internal */
+export const TrueFalse$inboundSchema = z.nativeEnum(TrueFalse);
+/** @internal */
+export const TrueFalse$outboundSchema = TrueFalse$inboundSchema;
+// =============================================================================
+// Sort Order Enum (Common across all list operations)
+// =============================================================================
+/**
+ * Sort order for list operations.
+ *
+ * @remarks
+ * Defines the order direction for sorting results.
+ */
+export const OrderBy = {
+    /** Ascending order */
+    Asc: 'asc',
+    /** Descending order */
+    Desc: 'desc',
+};
+/** @internal */
+export const OrderBy$inboundSchema = z.nativeEnum(OrderBy);
+/** @internal */
+export const OrderBy$outboundSchema = OrderBy$inboundSchema;
+// =============================================================================
+// GUID Reference Type Enums
+// =============================================================================
+/**
+ * Table 6.3.1 - AcadSessionGUIDRefTypeEnum
+ */
+export const AcademicSessionRefType = {
+    /** An object that is an 'Academic Session' */
+    AcademicSession: 'academicSession',
+};
+/** @internal */
+export const AcademicSessionRefType$inboundSchema = z.nativeEnum(AcademicSessionRefType);
+/** @internal */
+export const AcademicSessionRefType$outboundSchema = AcademicSessionRefType$inboundSchema;
+/**
+ * Table 6.3.3 - ClassGUIDRefTypeEnum
+ */
+export const ClassRefType = {
+    /** An object that is a 'Class' */
+    Class: 'class',
+};
+/** @internal */
+export const ClassRefType$inboundSchema = z.nativeEnum(ClassRefType);
+/** @internal */
+export const ClassRefType$outboundSchema = ClassRefType$inboundSchema;
+/**
+ * Table 6.3.5 - CourseGUIDRefTypeEnum
+ */
+export const CourseRefType = {
+    /** An object that is a 'Course' */
+    Course: 'course',
+};
+/** @internal */
+export const CourseRefType$inboundSchema = z.nativeEnum(CourseRefType);
+/** @internal */
+export const CourseRefType$outboundSchema = CourseRefType$inboundSchema;
+/**
+ * Table 6.3.8 - OrgGUIDRefTypeEnum
+ */
+export const OrgRefType = {
+    /** An object that is an 'Org' */
+    Org: 'org',
+};
+/** @internal */
+export const OrgRefType$inboundSchema = z.nativeEnum(OrgRefType);
+/** @internal */
+export const OrgRefType$outboundSchema = OrgRefType$inboundSchema;
+/**
+ * Table 6.3.10 - ResourceGUIDRefTypeEnum
+ */
+export const ResourceRefType = {
+    /** An object that is a 'Resource' */
+    Resource: 'resource',
+};
+/** @internal */
+export const ResourceRefType$inboundSchema = z.nativeEnum(ResourceRefType);
+/** @internal */
+export const ResourceRefType$outboundSchema = ResourceRefType$inboundSchema;
+/**
+ * Table 6.3.15 - UserGUIDRefTypeEnum
+ */
+export const UserRefType = {
+    /** An object that is a 'User' */
+    User: 'user',
+};
+/** @internal */
+export const UserRefType$inboundSchema = z.nativeEnum(UserRefType);
+/** @internal */
+export const UserRefType$outboundSchema = UserRefType$inboundSchema;
+// =============================================================================
+// Entity Type Enum (for GUID references across all entity types)
+// =============================================================================
+/**
+ * All OneRoster entity types.
+ *
+ * @remarks
+ * Used for GUID references that can point to any entity type.
+ */
+export const EntityType = {
+    AcademicSession: 'academicSession',
+    AssessmentLineItem: 'assessmentLineItem',
+    AssessmentResult: 'assessmentResult',
+    Category: 'category',
+    Class: 'class',
+    ComponentResource: 'componentResource',
+    Course: 'course',
+    CourseComponent: 'courseComponent',
+    Demographics: 'demographics',
+    Enrollment: 'enrollment',
+    GradingPeriod: 'gradingPeriod',
+    LineItem: 'lineItem',
+    Org: 'org',
+    Resource: 'resource',
+    Result: 'result',
+    ScoreScale: 'scoreScale',
+    Student: 'student',
+    Teacher: 'teacher',
+    Term: 'term',
+    User: 'user',
+};
+/** @internal */
+export const EntityType$inboundSchema = z.nativeEnum(EntityType);
+/** @internal */
+export const EntityType$outboundSchema = EntityType$inboundSchema;
+// =============================================================================
+// Score Status Enum (for Results)
+// =============================================================================
+/**
+ * Score status for result records.
+ *
+ * @remarks
+ * Indicates the status of a score/grade.
+ */
+export const ScoreStatus = {
+    /** The score is exempt */
+    Exempt: 'exempt',
+    /** The score is fully graded */
+    FullyGraded: 'fully graded',
+    /** The score is not submitted */
+    NotSubmitted: 'not submitted',
+    /** The score is partially graded */
+    PartiallyGraded: 'partially graded',
+    /** The score is submitted */
+    Submitted: 'submitted',
+};
+/** @internal */
+export const ScoreStatus$inboundSchema = z.nativeEnum(ScoreStatus);
+/** @internal */
+export const ScoreStatus$outboundSchema = ScoreStatus$inboundSchema;
+// =============================================================================
+// IMS Global Error Response Enums
+// =============================================================================
+/**
+ * Table 6.3.16 - imsx_CodeMajorEnum
+ *
+ * @remarks
+ * Major status codes for API responses.
+ */
+export const CodeMajor = {
+    /** Denotes that the transaction request has failed */
+    Failure: 'failure',
+    /** Denotes that the request is being processed at the destination */
+    Processing: 'processing',
+    /** Denotes that the request has been successfully completed */
+    Success: 'success',
+    /** Denotes that the service provider does not support the requested operation */
+    Unsupported: 'unsupported',
+};
+/** @internal */
+export const CodeMajor$inboundSchema = z.nativeEnum(CodeMajor);
+/** @internal */
+export const CodeMajor$outboundSchema = CodeMajor$inboundSchema;
+/**
+ * Table 6.3.17 - imsx_CodeMinorValueEnum
+ *
+ * @remarks
+ * Minor status codes providing detailed error information.
+ */
+export const CodeMinor = {
+    /** Server refuses to take action (HTTP 403) */
+    Forbidden: 'forbidden',
+    /** Request fully and successfully implemented (HTTP 200/201/204) */
+    FullSuccess: 'fullsuccess',
+    /** Catastrophic error (HTTP 500) */
+    InternalServerError: 'internal_server_error',
+    /** Invalid filter field supplied (HTTP 400) */
+    InvalidFilterField: 'invalid_filter_field',
+    /** Invalid selection field supplied (HTTP 400) */
+    InvalidSelectionField: 'invalid_selection_field',
+    /** Semantically erroneous JSON (HTTP 422) */
+    InvalidData: 'invaliddata',
+    /** Server receiving too many requests (HTTP 429) */
+    ServerBusy: 'server_busy',
+    /** Request not correctly authorised (HTTP 401) */
+    UnauthorisedRequest: 'unauthorisedrequest',
+    /** Supplied identifier is unknown (HTTP 404) */
+    UnknownObject: 'unknownobject',
+};
+/** @internal */
+export const CodeMinor$inboundSchema = z.nativeEnum(CodeMinor);
+/** @internal */
+export const CodeMinor$outboundSchema = CodeMinor$inboundSchema;
+/**
+ * Table 6.3.18 - imsx_SeverityEnum
+ *
+ * @remarks
+ * Severity level of the response status.
+ */
+export const Severity = {
+    /** A significant error has occurred */
+    Error: 'error',
+    /** The request has been completed and a response was received */
+    Status: 'status',
+    /** The request has only been partially completed */
+    Warning: 'warning',
+};
+/** @internal */
+export const Severity$inboundSchema = z.nativeEnum(Severity);
+/** @internal */
+export const Severity$outboundSchema = Severity$inboundSchema;
+// =============================================================================
+// Importance Enum (for Resources)
+// =============================================================================
+/**
+ * Importance level for resources.
+ */
+export const Importance = {
+    Primary: 'primary',
+    Secondary: 'secondary',
+};
+/** @internal */
+export const Importance$inboundSchema = z.nativeEnum(Importance);
+/** @internal */
+export const Importance$outboundSchema = Importance$inboundSchema;
+//# sourceMappingURL=enums.js.map

package/dist/esm/models/shared/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/models/shared/enums.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IAClB,uBAAuB;IACvB,MAAM,EAAE,QAAQ;IAChB,mDAAmD;IACnD,WAAW,EAAE,aAAa;CACpB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAmC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AACzF,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAmC,oBAAoB,CAAC;AAE1F,gFAAgF;AAChF,8BAA8B;AAC9B,gFAAgF;AAEhF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,sEAAsE;IACtE,OAAO,EAAE,SAAS;IAClB,iEAAiE;IACjE,SAAS,EAAE,WAAW;CAChB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAqC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAC/F,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAqC,sBAAsB,CAAC;AAEhG,gFAAgF;AAChF,uCAAuC;AACvC,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,oDAAoD;IACpD,aAAa,EAAE,eAAe;IAC9B,uBAAuB;IACvB,IAAI,EAAE,MAAM;IACZ,yBAAyB;IACzB,SAAS,EAAE,WAAW;IACtB,qCAAqC;IACrC,qBAAqB,EAAE,uBAAuB;IAC9C,8BAA8B;IAC9B,QAAQ,EAAE,UAAU;IACpB,4BAA4B;IAC5B,MAAM,EAAE,QAAQ;IAChB,yBAAyB;IACzB,SAAS,EAAE,WAAW;IACtB,sBAAsB;IACtB,OAAO,EAAE,SAAS;IAClB,8BAA8B;IAC9B,QAAQ,EAAE,UAAU;IACpB,iCAAiC;IACjC,iBAAiB,EAAE,mBAAmB;IACtC,mCAAmC;IACnC,OAAO,EAAE,SAAS;IAClB,mCAAmC;IACnC,mBAAmB,EAAE,qBAAqB;IAC1C,mCAAmC;IACnC,OAAO,EAAE,SAAS;CACZ,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAqC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAC/F,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAqC,sBAAsB,CAAC;AAEhG,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,kEAAkE;IAClE,aAAa,EAAE,eAAe;IAC9B,mBAAmB;IACnB,OAAO,EAAE,SAAS;IAClB,+CAA+C;IAC/C,OAAO,EAAE,SAAS;IAClB,+CAA+C;IAC/C,OAAO,EAAE,SAAS;CACZ,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GACrC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACjC,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GACtC,4BAA4B,CAAC;AAEjC,gFAAgF;AAChF,iCAAiC;AACjC,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,qEAAqE;IACrE,aAAa,EAAE,eAAe;IAC9B,8BAA8B;IAC9B,UAAU,EAAE,YAAY;IACxB,kFAAkF;IAClF,QAAQ,EAAE,UAAU;IACpB,4EAA4E;IAC5E,IAAI,EAAE,MAAM;CACN,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAC9B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACnC,yBAAyB,CAAC;AAE9B,gFAAgF;AAChF,8BAA8B;AAC9B,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,gDAAgD;IAChD,QAAQ,EAAE,UAAU;IACpB,6CAA6C;IAC7C,SAAS,EAAE,WAAW;CAChB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAsC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AAClG,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAsC,uBAAuB,CAAC;AAEnG,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,yFAAyF;IACzF,UAAU,EAAE,YAAY;IACxB,gCAAgC;IAChC,QAAQ,EAAE,UAAU;IACpB,yFAAyF;IACzF,KAAK,EAAE,OAAO;IACd,4CAA4C;IAC5C,QAAQ,EAAE,UAAU;IACpB,mFAAmF;IACnF,MAAM,EAAE,QAAQ;IAChB,yCAAyC;IACzC,KAAK,EAAE,OAAO;CACR,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAoC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAC5F,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAoC,qBAAqB,CAAC;AAE7F,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IAClB,uBAAuB;IACvB,MAAM,EAAE,QAAQ;IAChB,qBAAqB;IACrB,IAAI,EAAE,MAAM;IACZ,2FAA2F;IAC3F,KAAK,EAAE,OAAO;IACd,uFAAuF;IACvF,WAAW,EAAE,aAAa;CACpB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAmC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AACzF,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAmC,oBAAoB,CAAC;AAE1F,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,wDAAwD;IACxD,KAAK,EAAE,OAAO;IACd,uDAAuD;IACvD,IAAI,EAAE,MAAM;CACN,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAsC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AAClG,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAsC,uBAAuB,CAAC;AAEnG,gFAAgF;AAChF,sDAAsD;AACtD,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,sBAAsB;IACtB,GAAG,EAAE,KAAK;IACV,uBAAuB;IACvB,IAAI,EAAE,MAAM;CACN,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAoC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAC5F,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAoC,qBAAqB,CAAC;AAE7F,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IAClC,8CAA8C;IAC9C,eAAe,EAAE,iBAAiB;CAC5B,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAC7C,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACzC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAC9C,oCAAoC,CAAC;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,kCAAkC;IAClC,KAAK,EAAE,OAAO;CACR,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACnC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;AAC/B,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GACpC,0BAA0B,CAAC;AAE/B;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IACzB,mCAAmC;IACnC,MAAM,EAAE,QAAQ;CACV,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GACpC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAChC,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GACrC,2BAA2B,CAAC;AAEhC;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB,iCAAiC;IACjC,GAAG,EAAE,KAAK;CACJ,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GACjC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC3B,qCAAqC;IACrC,QAAQ,EAAE,UAAU;CACd,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GACtC,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;AAClC,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GACvC,6BAA6B,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,iCAAiC;IACjC,IAAI,EAAE,MAAM;CACN,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAC9B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACnC,yBAAyB,CAAC;AAE9B,gFAAgF;AAChF,iEAAiE;AACjE,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB,eAAe,EAAE,iBAAiB;IAClC,kBAAkB,EAAE,oBAAoB;IACxC,gBAAgB,EAAE,kBAAkB;IACpC,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,mBAAmB;IACtC,MAAM,EAAE,QAAQ;IAChB,eAAe,EAAE,iBAAiB;IAClC,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,UAAU;IACpB,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACN,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GACjC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,wBAAwB,CAAC;AAE7B,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,0BAA0B;IAC1B,MAAM,EAAE,QAAQ;IAChB,gCAAgC;IAChC,WAAW,EAAE,cAAc;IAC3B,iCAAiC;IACjC,YAAY,EAAE,eAAe;IAC7B,oCAAoC;IACpC,eAAe,EAAE,kBAAkB;IACnC,6BAA6B;IAC7B,SAAS,EAAE,WAAW;CAChB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAC9B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACnC,yBAAyB,CAAC;AAE9B,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,sDAAsD;IACtD,OAAO,EAAE,SAAS;IAClB,qEAAqE;IACrE,UAAU,EAAE,YAAY;IACxB,+DAA+D;IAC/D,OAAO,EAAE,SAAS;IAClB,iFAAiF;IACjF,WAAW,EAAE,aAAa;CACpB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAsC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AAClG,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAsC,uBAAuB,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,+CAA+C;IAC/C,SAAS,EAAE,WAAW;IACtB,oEAAoE;IACpE,WAAW,EAAE,aAAa;IAC1B,oCAAoC;IACpC,mBAAmB,EAAE,uBAAuB;IAC5C,+CAA+C;IAC/C,kBAAkB,EAAE,sBAAsB;IAC1C,kDAAkD;IAClD,qBAAqB,EAAE,yBAAyB;IAChD,6CAA6C;IAC7C,WAAW,EAAE,aAAa;IAC1B,oDAAoD;IACpD,UAAU,EAAE,aAAa;IACzB,kDAAkD;IAClD,mBAAmB,EAAE,qBAAqB;IAC1C,gDAAgD;IAChD,aAAa,EAAE,eAAe;CACxB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAsC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AAClG,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAsC,uBAAuB,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,uCAAuC;IACvC,KAAK,EAAE,OAAO;IACd,iEAAiE;IACjE,MAAM,EAAE,QAAQ;IAChB,oDAAoD;IACpD,OAAO,EAAE,SAAS;CACZ,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAqC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAC/F,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAqC,sBAAsB,CAAC;AAEhG,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CAChB,CAAC;AAGX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GACjC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAClC,wBAAwB,CAAC"}

package/dist/esm/models/shared/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shared OneRoster Types and Enums
+ *
+ * This module exports all shared types and enums used across the OneRoster SDK.
+ * These are based on the 1EdTech OneRoster v1.2 specification.
+ */
+export * from './enums.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/models/shared/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/shared/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,YAAY,CAAC"}

package/dist/esm/models/shared/index.js

@@ -0,0 +1,8 @@
+/**
+ * Shared OneRoster Types and Enums
+ *
+ * This module exports all shared types and enums used across the OneRoster SDK.
+ * These are based on the 1EdTech OneRoster v1.2 specification.
+ */
+export * from './enums.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/shared/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/shared/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,YAAY,CAAC"}

package/package.json

@@ -1,7 +1,46 @@
 {
     "name": "@eduware/oneroster",
-    "version": "1.2.3",
+    "version": "1.2.5",
+    "description": "A TypeScript/JavaScript SDK for the OneRoster API standard - manage students, teachers, classes, enrollments, and academic data for K-12 education systems",
     "author": "Eduware",
+    "license": "MIT",
+    "keywords": [
+        "oneroster",
+        "one-roster",
+        "education",
+        "edtech",
+        "k12",
+        "k-12",
+        "sis",
+        "student-information-system",
+        "lms",
+        "learning-management-system",
+        "classlink",
+        "clever",
+        "api",
+        "sdk",
+        "typescript",
+        "javascript",
+        "rest-api",
+        "oauth",
+        "oauth1",
+        "oauth2",
+        "students",
+        "teachers",
+        "classes",
+        "enrollments",
+        "schools",
+        "courses",
+        "academic-sessions",
+        "grading",
+        "roster",
+        "rostering",
+        "ims-global",
+        "1edtech",
+        "interoperability",
+        "mcp",
+        "model-context-protocol"
+    ],
     "type": "module",
     "tshy": {
         "sourceDialects": [
@@ -16,6 +55,7 @@
             "./models/errors": "./src/models/errors/index.ts",
             "./models/components": "./src/models/components/index.ts",
             "./models/operations": "./src/models/operations/index.ts",
+            "./models/shared": "./src/models/shared/index.ts",
             "./*.js": "./src/*.ts",
             "./*": "./src/*.ts"
         }
@@ -148,6 +188,17 @@
                 "default": "./dist/commonjs/models/operations/index.js"
             }
         },
+        "./models/shared": {
+            "import": {
+                "@eduware/oneroster/source": "./src/models/shared/index.ts",
+                "types": "./dist/esm/models/shared/index.d.ts",
+                "default": "./dist/esm/models/shared/index.js"
+            },
+            "require": {
+                "types": "./dist/commonjs/models/shared/index.d.ts",
+                "default": "./dist/commonjs/models/shared/index.js"
+            }
+        },
         "./*.js": {
             "import": {
                 "@eduware/oneroster/source": "./src/*.ts",
@@ -194,6 +245,9 @@
             "models/operations": [
                 "./dist/esm/models/operations/index.d.ts"
             ],
+            "models/shared": [
+                "./dist/esm/models/shared/index.d.ts"
+            ],
             "*": [
                 "./dist/esm/*.d.ts"
             ]

package/src/index.ts

@@ -6,3 +6,47 @@ export * from './sdk/sdk.js';
 
 // Clients - LMS-specific profile interfaces and typed client aliases
 export * as clients from './clients/index.js';
+
+// Shared Enums - OneRoster specification enums (also available via @eduware/oneroster/models/shared)
+export * as enums from './models/shared/index.js';
+export {
+    // GUID reference types
+    AcademicSessionRefType,
+    ClassRefType,
+    ClassType,
+    // Error response enums
+    CodeMajor,
+    CodeMinor,
+    CourseRefType,
+    EnrollmentRole,
+    EntityType,
+    Gender,
+    Importance,
+    OrderBy,
+    OrgRefType,
+    OrgType,
+    ResourceRefType,
+    RoleType,
+    // Result/Score enums
+    ScoreStatus,
+    SessionType,
+    Severity,
+    // Core enums
+    Status,
+    TrueFalse,
+    UserRefType,
+    UserRole,
+} from './models/shared/index.js';
+
+// Errors - Re-export for convenience (also available via @eduware/oneroster/models/errors)
+export * as errors from './models/errors/index.js';
+export {
+    BadRequestResponseError,
+    ForbiddenResponseError,
+    InternalServerErrorResponse,
+    NotFoundResponseError,
+    OneRosterError,
+    TooManyRequestsResponseError,
+    UnauthorizedRequestResponseError,
+    UnprocessableEntityResponseError,
+} from './models/errors/index.js';

package/src/models/errors/index.ts

@@ -4,6 +4,7 @@ export * from './forbiddenresponseerror.js';
 export * from './httpclienterrors.js';
 export * from './internalservererrorresponse.js';
 export * from './notfoundresponseerror.js';
+export * from './onerostererror.js';
 export * from './responsevalidationerror.js';
 export * from './sdkvalidationerror.js';
 export * from './toomanyrequestsresponseerror.js';