@eduware/oneroster 1.2.3 → 1.2.5

package/src/models/shared/enums.ts

@@ -0,0 +1,567 @@
+/**
+ * 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';
+
+import { ClosedEnum } from '../../types/enums.js';
+
+// =============================================================================
+// 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',
+} as const;
+export type Status = ClosedEnum<typeof Status>;
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z.nativeEnum(Status);
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> = 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',
+} as const;
+export type RoleType = ClosedEnum<typeof RoleType>;
+
+/** @internal */
+export const RoleType$inboundSchema: z.ZodNativeEnum<typeof RoleType> = z.nativeEnum(RoleType);
+/** @internal */
+export const RoleType$outboundSchema: z.ZodNativeEnum<typeof RoleType> = 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',
+} as const;
+export type UserRole = ClosedEnum<typeof UserRole>;
+
+/** @internal */
+export const UserRole$inboundSchema: z.ZodNativeEnum<typeof UserRole> = z.nativeEnum(UserRole);
+/** @internal */
+export const UserRole$outboundSchema: z.ZodNativeEnum<typeof UserRole> = 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',
+} as const;
+export type EnrollmentRole = ClosedEnum<typeof EnrollmentRole>;
+
+/** @internal */
+export const EnrollmentRole$inboundSchema: z.ZodNativeEnum<typeof EnrollmentRole> =
+    z.nativeEnum(EnrollmentRole);
+/** @internal */
+export const EnrollmentRole$outboundSchema: z.ZodNativeEnum<typeof EnrollmentRole> =
+    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',
+} as const;
+export type SessionType = ClosedEnum<typeof SessionType>;
+
+/** @internal */
+export const SessionType$inboundSchema: z.ZodNativeEnum<typeof SessionType> =
+    z.nativeEnum(SessionType);
+/** @internal */
+export const SessionType$outboundSchema: z.ZodNativeEnum<typeof SessionType> =
+    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',
+} as const;
+export type ClassType = ClosedEnum<typeof ClassType>;
+
+/** @internal */
+export const ClassType$inboundSchema: z.ZodNativeEnum<typeof ClassType> = z.nativeEnum(ClassType);
+/** @internal */
+export const ClassType$outboundSchema: z.ZodNativeEnum<typeof ClassType> = 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',
+} as const;
+export type OrgType = ClosedEnum<typeof OrgType>;
+
+/** @internal */
+export const OrgType$inboundSchema: z.ZodNativeEnum<typeof OrgType> = z.nativeEnum(OrgType);
+/** @internal */
+export const OrgType$outboundSchema: z.ZodNativeEnum<typeof OrgType> = 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',
+} as const;
+export type Gender = ClosedEnum<typeof Gender>;
+
+/** @internal */
+export const Gender$inboundSchema: z.ZodNativeEnum<typeof Gender> = z.nativeEnum(Gender);
+/** @internal */
+export const Gender$outboundSchema: z.ZodNativeEnum<typeof Gender> = 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',
+} as const;
+export type TrueFalse = ClosedEnum<typeof TrueFalse>;
+
+/** @internal */
+export const TrueFalse$inboundSchema: z.ZodNativeEnum<typeof TrueFalse> = z.nativeEnum(TrueFalse);
+/** @internal */
+export const TrueFalse$outboundSchema: z.ZodNativeEnum<typeof TrueFalse> = 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',
+} as const;
+export type OrderBy = ClosedEnum<typeof OrderBy>;
+
+/** @internal */
+export const OrderBy$inboundSchema: z.ZodNativeEnum<typeof OrderBy> = z.nativeEnum(OrderBy);
+/** @internal */
+export const OrderBy$outboundSchema: z.ZodNativeEnum<typeof OrderBy> = OrderBy$inboundSchema;
+
+// =============================================================================
+// GUID Reference Type Enums
+// =============================================================================
+
+/**
+ * Table 6.3.1 - AcadSessionGUIDRefTypeEnum
+ */
+export const AcademicSessionRefType = {
+    /** An object that is an 'Academic Session' */
+    AcademicSession: 'academicSession',
+} as const;
+export type AcademicSessionRefType = ClosedEnum<typeof AcademicSessionRefType>;
+
+/** @internal */
+export const AcademicSessionRefType$inboundSchema: z.ZodNativeEnum<typeof AcademicSessionRefType> =
+    z.nativeEnum(AcademicSessionRefType);
+/** @internal */
+export const AcademicSessionRefType$outboundSchema: z.ZodNativeEnum<typeof AcademicSessionRefType> =
+    AcademicSessionRefType$inboundSchema;
+
+/**
+ * Table 6.3.3 - ClassGUIDRefTypeEnum
+ */
+export const ClassRefType = {
+    /** An object that is a 'Class' */
+    Class: 'class',
+} as const;
+export type ClassRefType = ClosedEnum<typeof ClassRefType>;
+
+/** @internal */
+export const ClassRefType$inboundSchema: z.ZodNativeEnum<typeof ClassRefType> =
+    z.nativeEnum(ClassRefType);
+/** @internal */
+export const ClassRefType$outboundSchema: z.ZodNativeEnum<typeof ClassRefType> =
+    ClassRefType$inboundSchema;
+
+/**
+ * Table 6.3.5 - CourseGUIDRefTypeEnum
+ */
+export const CourseRefType = {
+    /** An object that is a 'Course' */
+    Course: 'course',
+} as const;
+export type CourseRefType = ClosedEnum<typeof CourseRefType>;
+
+/** @internal */
+export const CourseRefType$inboundSchema: z.ZodNativeEnum<typeof CourseRefType> =
+    z.nativeEnum(CourseRefType);
+/** @internal */
+export const CourseRefType$outboundSchema: z.ZodNativeEnum<typeof CourseRefType> =
+    CourseRefType$inboundSchema;
+
+/**
+ * Table 6.3.8 - OrgGUIDRefTypeEnum
+ */
+export const OrgRefType = {
+    /** An object that is an 'Org' */
+    Org: 'org',
+} as const;
+export type OrgRefType = ClosedEnum<typeof OrgRefType>;
+
+/** @internal */
+export const OrgRefType$inboundSchema: z.ZodNativeEnum<typeof OrgRefType> =
+    z.nativeEnum(OrgRefType);
+/** @internal */
+export const OrgRefType$outboundSchema: z.ZodNativeEnum<typeof OrgRefType> =
+    OrgRefType$inboundSchema;
+
+/**
+ * Table 6.3.10 - ResourceGUIDRefTypeEnum
+ */
+export const ResourceRefType = {
+    /** An object that is a 'Resource' */
+    Resource: 'resource',
+} as const;
+export type ResourceRefType = ClosedEnum<typeof ResourceRefType>;
+
+/** @internal */
+export const ResourceRefType$inboundSchema: z.ZodNativeEnum<typeof ResourceRefType> =
+    z.nativeEnum(ResourceRefType);
+/** @internal */
+export const ResourceRefType$outboundSchema: z.ZodNativeEnum<typeof ResourceRefType> =
+    ResourceRefType$inboundSchema;
+
+/**
+ * Table 6.3.15 - UserGUIDRefTypeEnum
+ */
+export const UserRefType = {
+    /** An object that is a 'User' */
+    User: 'user',
+} as const;
+export type UserRefType = ClosedEnum<typeof UserRefType>;
+
+/** @internal */
+export const UserRefType$inboundSchema: z.ZodNativeEnum<typeof UserRefType> =
+    z.nativeEnum(UserRefType);
+/** @internal */
+export const UserRefType$outboundSchema: z.ZodNativeEnum<typeof UserRefType> =
+    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',
+} as const;
+export type EntityType = ClosedEnum<typeof EntityType>;
+
+/** @internal */
+export const EntityType$inboundSchema: z.ZodNativeEnum<typeof EntityType> =
+    z.nativeEnum(EntityType);
+/** @internal */
+export const EntityType$outboundSchema: z.ZodNativeEnum<typeof EntityType> =
+    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',
+} as const;
+export type ScoreStatus = ClosedEnum<typeof ScoreStatus>;
+
+/** @internal */
+export const ScoreStatus$inboundSchema: z.ZodNativeEnum<typeof ScoreStatus> =
+    z.nativeEnum(ScoreStatus);
+/** @internal */
+export const ScoreStatus$outboundSchema: z.ZodNativeEnum<typeof ScoreStatus> =
+    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',
+} as const;
+export type CodeMajor = ClosedEnum<typeof CodeMajor>;
+
+/** @internal */
+export const CodeMajor$inboundSchema: z.ZodNativeEnum<typeof CodeMajor> = z.nativeEnum(CodeMajor);
+/** @internal */
+export const CodeMajor$outboundSchema: z.ZodNativeEnum<typeof CodeMajor> = 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',
+} as const;
+export type CodeMinor = ClosedEnum<typeof CodeMinor>;
+
+/** @internal */
+export const CodeMinor$inboundSchema: z.ZodNativeEnum<typeof CodeMinor> = z.nativeEnum(CodeMinor);
+/** @internal */
+export const CodeMinor$outboundSchema: z.ZodNativeEnum<typeof CodeMinor> = 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',
+} as const;
+export type Severity = ClosedEnum<typeof Severity>;
+
+/** @internal */
+export const Severity$inboundSchema: z.ZodNativeEnum<typeof Severity> = z.nativeEnum(Severity);
+/** @internal */
+export const Severity$outboundSchema: z.ZodNativeEnum<typeof Severity> = Severity$inboundSchema;
+
+// =============================================================================
+// Importance Enum (for Resources)
+// =============================================================================
+
+/**
+ * Importance level for resources.
+ */
+export const Importance = {
+    Primary: 'primary',
+    Secondary: 'secondary',
+} as const;
+export type Importance = ClosedEnum<typeof Importance>;
+
+/** @internal */
+export const Importance$inboundSchema: z.ZodNativeEnum<typeof Importance> =
+    z.nativeEnum(Importance);
+/** @internal */
+export const Importance$outboundSchema: z.ZodNativeEnum<typeof Importance> =
+    Importance$inboundSchema;

package/src/models/shared/index.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';