@timeback/oneroster 0.1.0 → 0.1.2

package/dist/types/rostering.d.ts

@@ -1,732 +0,0 @@
-/**
- * OneRoster Rostering Types
- *
- * Types for rostering entities: users, orgs, courses, classes, enrollments, terms.
- */
-import type { OneRosterUserRole, OrganizationType, TimebackGrade, TimebackSubject } from '@timeback/types';
-import type { Base, Ref, RefWithHref } from './base';
-/**
- * An organization such as a school, district, or department.
- *
- * Organizations form a hierarchy with parent/child relationships.
- * Schools are a specific type of organization.
- */
-export interface Organization extends Base {
-    /** Display name of the organization */
-    name: string;
-    /** Type of organization (school, district, department, etc.) */
-    type: OrganizationType;
-    /** External identifier (e.g., state school ID) */
-    identifier?: string;
-    /** Reference to parent organization */
-    parent?: RefWithHref | null;
-    /** References to child organizations */
-    children?: RefWithHref[] | null;
-}
-/**
- * Input for creating/updating an organization.
- * Uses simple Ref (just sourcedId) for references.
- */
-export interface OrgCreateInput {
-    /** Client-supplied sourcedId (optional, server generates if omitted) */
-    sourcedId?: string;
-    /** Status */
-    status?: 'active' | 'tobedeleted';
-    /** Metadata */
-    metadata?: Record<string, unknown>;
-    /** Display name of the organization */
-    name: string;
-    /** Type of organization */
-    type: OrganizationType;
-    /** External identifier */
-    identifier?: string | null;
-    /** Parent organization reference */
-    parent?: Ref | null;
-}
-/**
- * Input for creating/updating a school (org with type='school').
- */
-export type SchoolCreateInput = Omit<OrgCreateInput, 'type'> & {
-    type?: 'school';
-};
-/**
- * An external user identifier from another system.
- */
-export interface UserId {
-    /** Type of identifier (e.g., "SIS", "LDAP") */
-    type: string;
-    /** The identifier value */
-    identifier: string;
-}
-/**
- * A role assignment for a user at a specific organization.
- */
-export interface UserRole {
-    /** Whether this is the user's primary or secondary role */
-    roleType: 'primary' | 'secondary';
-    /** The role type (student, teacher, administrator, etc.) */
-    role: OneRosterUserRole;
-    /** The organization where this role applies */
-    org: RefWithHref;
-    /** Associated user profile identifier */
-    userProfile?: string;
-    /** Role-specific metadata */
-    metadata?: Record<string, unknown> | null;
-    /** When this role assignment begins */
-    beginDate?: string | null;
-    /** When this role assignment ends */
-    endDate?: string | null;
-}
-/**
- * Role assignment input for user creation/update.
- * Uses simple Ref (just sourcedId) for org reference.
- */
-export interface UserRoleInput {
-    /** Whether this is the user's primary or secondary role */
-    roleType: 'primary' | 'secondary';
-    /** The role type */
-    role: OneRosterUserRole;
-    /** The organization where this role applies (simple ref) */
-    org: Ref;
-    /** Associated user profile identifier */
-    userProfile?: string;
-    /** Role-specific metadata */
-    metadata?: Record<string, unknown> | null;
-    /** When this role assignment begins */
-    beginDate?: string | null;
-    /** When this role assignment ends */
-    endDate?: string | null;
-}
-/** @internal */
-export interface UserProfileCredential {
-    id: string;
-    type: string;
-    username: string;
-    password?: string | null;
-}
-/** @internal */
-export interface UserProfileApp {
-    sourcedId: string;
-    name: string;
-    description?: string | null;
-    domain: string[];
-    metadata?: Record<string, unknown> | null;
-}
-/** @internal */
-export interface UserProfile {
-    profileId: string;
-    profileType: string;
-    vendorId: string;
-    applicationId: string;
-    description?: string | null;
-    app: UserProfileApp;
-    credentials: UserProfileCredential[];
-}
-/**
- * A user in the OneRoster system.
- *
- * Users can be students, teachers, parents, administrators, or other roles.
- * A user may have multiple roles at different organizations.
- */
-export interface User extends Base {
-    /** Master identifier for cross-system user matching */
-    userMasterIdentifier?: string | null;
-    /** Login username */
-    username?: string | null;
-    /** External identifiers from other systems */
-    userIds?: UserId[];
-    /** Whether the user account is enabled */
-    enabledUser: boolean;
-    /** User's first name */
-    givenName: string;
-    /** User's last name */
-    familyName: string;
-    /** User's middle name */
-    middleName?: string | null;
-    /** External identifier */
-    identifier?: string | null;
-    /** User's email address */
-    email?: string;
-    /** Role assignments at organizations */
-    roles: UserRole[];
-    /** References to related users (e.g., parents for students) */
-    agents?: RefWithHref[];
-    /** Application-specific profiles */
-    userProfiles?: UserProfile[];
-    /** User's primary organization */
-    primaryOrg?: RefWithHref & {
-        name?: string | null;
-    };
-    /** Preferred first name */
-    preferredFirstName?: string | null;
-    /** Preferred middle name */
-    preferredMiddleName?: string | null;
-    /** Preferred last name */
-    preferredLastName?: string | null;
-    /** User's pronouns */
-    pronouns?: string | null;
-    /** Grade levels associated with the user */
-    grades?: TimebackGrade[];
-    /** Password (write-only, not returned in responses) */
-    password?: string | null;
-    /** SMS phone number */
-    sms?: string | null;
-    /** Phone number */
-    phone?: string | null;
-    /** Demographic information */
-    demographics?: Demographics | null;
-}
-/**
- * Input for creating/updating a user.
- * Uses simple Ref (just sourcedId) for references.
- */
-export interface UserCreateInput {
-    /** Client-supplied sourcedId (optional) */
-    sourcedId?: string;
-    /** Status */
-    status?: 'active' | 'tobedeleted';
-    /** Metadata */
-    metadata?: Record<string, unknown>;
-    /** Master identifier for cross-system matching */
-    userMasterIdentifier?: string | null;
-    /** Login username */
-    username?: string | null;
-    /** External identifiers */
-    userIds?: UserId[];
-    /** Whether the user account is enabled */
-    enabledUser: boolean;
-    /** User's first name */
-    givenName: string;
-    /** User's last name */
-    familyName: string;
-    /** User's middle name */
-    middleName?: string | null;
-    /** User's email address */
-    email: string;
-    /** Role assignments (uses simple Ref for org) */
-    roles: UserRoleInput[];
-    /** Agent references (simple refs) */
-    agents?: Ref[];
-    /** Primary organization (simple ref) */
-    primaryOrg?: Ref;
-    /** Preferred first name */
-    preferredFirstName?: string | null;
-    /** Preferred middle name */
-    preferredMiddleName?: string | null;
-    /** Preferred last name */
-    preferredLastName?: string | null;
-    /** User's pronouns */
-    pronouns?: string | null;
-    /** Grade levels */
-    grades?: TimebackGrade[];
-    /** Password (write-only) */
-    password?: string | null;
-    /** SMS phone number */
-    sms?: string | null;
-    /** Phone number */
-    phone?: string | null;
-}
-/**
- * Demographic information for a user.
- *
- * Contains sensitive PII data including birth date, race, and ethnicity.
- */
-export interface Demographics extends Base {
-    /** Birth date in YYYY-MM-DD format */
-    birthDate?: string | null;
-    /** Biological sex */
-    sex?: 'male' | 'female' | 'other' | 'unspecified' | null;
-    americanIndianOrAlaskaNative?: string | null;
-    asian?: string | null;
-    blackOrAfricanAmerican?: string | null;
-    nativeHawaiianOrOtherPacificIslander?: string | null;
-    white?: string | null;
-    demographicRaceTwoOrMoreRaces?: string | null;
-    hispanicOrLatinoEthnicity?: string | null;
-    countryOfBirthCode?: string | null;
-    stateOfBirthAbbreviation?: string | null;
-    cityOfBirth?: string | null;
-    publicSchoolResidenceStatus?: string | null;
-}
-/**
- * Input for creating/updating demographics.
- * sourcedId must match an existing user's sourcedId.
- */
-export interface DemographicsCreateInput {
-    /** Must match an existing user's sourcedId */
-    sourcedId: string;
-    /** Status */
-    status?: 'active' | 'tobedeleted';
-    /** Metadata */
-    metadata?: Record<string, unknown>;
-    /** Birth date in YYYY-MM-DD format */
-    birthDate?: string | null;
-    /** Biological sex */
-    sex?: 'male' | 'female' | null;
-    americanIndianOrAlaskaNative?: boolean | null;
-    asian?: boolean | null;
-    blackOrAfricanAmerican?: boolean | null;
-    nativeHawaiianOrOtherPacificIslander?: boolean | null;
-    white?: boolean | null;
-    demographicRaceTwoOrMoreRaces?: boolean | null;
-    hispanicOrLatinoEthnicity?: boolean | null;
-    countryOfBirthCode?: string | null;
-    stateOfBirthAbbreviation?: string | null;
-    cityOfBirth?: string | null;
-    publicSchoolResidenceStatus?: string | null;
-}
-/**
- * Daily learning goals for a course or enrollment.
- */
-export interface CourseGoals {
-    /** Target XP to earn per day */
-    dailyXp?: number;
-    /** Target lessons to complete per day */
-    dailyLessons?: number;
-    /** Target active learning minutes per day */
-    dailyActiveMinutes?: number;
-    /** Target accuracy percentage */
-    dailyAccuracy?: number;
-    /** Target mastered units per day */
-    dailyMasteredUnits?: number;
-}
-/**
- * Aggregate metrics for a course.
- */
-export interface CourseMetrics {
-    /** Total XP available in the course */
-    totalXp?: number;
-    /** Total number of lessons/activities */
-    totalLessons?: number;
-    /** Total grade levels covered */
-    totalGrades?: number;
-    /** Course classification type */
-    courseType?: 'base' | 'hole-filling' | 'optional' | 'Base' | 'Hole-Filling' | 'Optional';
-    /** Whether this is supplemental content */
-    isSupplemental?: boolean;
-}
-/**
- * Extended metadata for courses.
- */
-export interface CourseMetadata extends Record<string, unknown> {
-    /** Course classification (base, hole-filling, optional) */
-    courseType?: 'base' | 'hole-filling' | 'optional';
-    /** Whether this is supplemental content */
-    isSupplemental?: boolean;
-    /** Whether this is a custom course for a specific student */
-    isCustom?: boolean;
-    /** Publication status of the course */
-    publishStatus?: 'draft' | 'testing' | 'published' | 'deactivated';
-    /** Contact email for course issues */
-    contactEmail?: string;
-    /** Primary application identifier */
-    primaryApp?: string;
-    /** Daily learning goals */
-    goals?: CourseGoals;
-    /** Aggregate metrics */
-    metrics?: CourseMetrics;
-}
-/**
- * A course in the curriculum.
- *
- * Courses define the content to be taught and can have multiple classes
- * (sections) associated with them.
- */
-export interface Course extends Omit<Base, 'metadata'> {
-    /** Course-specific metadata */
-    metadata?: CourseMetadata | null;
-    /** Course title */
-    title: string;
-    /** Course code (e.g., "MATH101") */
-    courseCode?: string;
-    /** Grade levels for this course */
-    grades?: TimebackGrade[];
-    /** Subject areas */
-    subjects?: TimebackSubject[];
-    /** Subject codes */
-    subjectCodes?: string[];
-    /** Organization offering this course */
-    org: Ref;
-    /** Course level (e.g., "AP", "Honors") */
-    level?: string;
-    /** Grading scheme identifier */
-    gradingScheme?: string;
-    /** Associated academic session */
-    academicSession?: Ref;
-    /** School year reference */
-    schoolYear?: RefWithHref;
-    /** Learning resources for this course */
-    resources?: RefWithHref[];
-}
-/**
- * Input for creating a new course.
- *
- * Required fields: title, org, status
- */
-export interface CourseCreateInput {
-    /** Client-supplied sourcedId (optional) */
-    sourcedId?: string;
-    /** Course title */
-    title: string;
-    /** Organization offering this course */
-    org: Ref;
-    /** Status (required for creation) */
-    status: 'active' | 'tobedeleted';
-    /** Course code (e.g., "MATH101") */
-    courseCode?: string;
-    /** Grade levels for this course */
-    grades?: TimebackGrade[];
-    /** Subject areas */
-    subjects?: TimebackSubject[];
-    /** Subject codes */
-    subjectCodes?: string[];
-    /** Course level (e.g., "AP", "Honors") */
-    level?: string;
-    /** Course-specific metadata */
-    metadata?: CourseMetadata | null;
-}
-/**
- * A single item in a QTI-derived course structure.
- *
- * Represents metadata about a lesson/skill from QTI test content.
- */
-export interface CourseStructureItem {
-    /** URL to the QTI content */
-    url: string;
-    /** Skill code identifier */
-    skillCode: string;
-    /** Lesson code identifier */
-    lessonCode: string;
-    /** Title of the lesson/skill */
-    title: string;
-    /** Title of the containing unit */
-    'unit-title': string;
-    /** Status of the content */
-    status: string;
-    /** Experience points value */
-    xp: number;
-    /** Optional stimulus content */
-    stimulus?: {
-        title: string;
-        identifier: string;
-    };
-    /** Optional video content */
-    video?: {
-        url: string;
-        title: string;
-    };
-}
-/**
- * Input for creating a course structure from QTI tests.
- *
- * Contains both the course to create and the QTI-derived structure.
- */
-export interface CourseStructureInput {
-    /** The course to create */
-    course: CourseCreateInput;
-    /** Map of property names to course structure items */
-    courseStructure: Record<string, CourseStructureItem>;
-}
-/**
- * A component or module within a course.
- */
-export interface CourseComponent extends Base {
-    /** Display title */
-    title: string;
-    /** Parent course reference */
-    course: Ref;
-    /** Nested course component reference */
-    courseComponent?: Ref | null;
-    /** Parent component reference */
-    parent?: Ref | null;
-    /** Display order */
-    sortOrder?: number;
-    /** Prerequisite component IDs */
-    prerequisites?: string[];
-    /** Whether all or any prerequisites are required */
-    prerequisiteCriteria?: 'ALL' | 'ANY';
-    /** Date when component becomes available */
-    unlockDate?: string;
-}
-/**
- * Input for creating a new course component.
- */
-export interface CourseComponentCreateInput {
-    /** Component title */
-    title: string;
-    /** Parent course reference */
-    course: Ref;
-    /** Status */
-    status: 'active' | 'tobedeleted';
-    /** Client-supplied sourcedId (optional) */
-    sourcedId?: string;
-    /** Parent component reference (for nesting) */
-    parent?: Ref | null;
-    /** Display order */
-    sortOrder?: number;
-    /** Prerequisite component IDs */
-    prerequisites?: string[] | null;
-    /** Whether all or any prerequisites are required */
-    prerequisiteCriteria?: string | null;
-    /** Date when component becomes available */
-    unlockDate?: string;
-}
-/**
- * A class (section) where students and teachers meet.
- *
- * Classes are instances of courses for specific terms and locations.
- */
-export interface Class extends Base {
-    /** Class title */
-    title: string;
-    /** Class code/section identifier */
-    classCode?: string | null;
-    /** Type of class */
-    classType?: 'homeroom' | 'scheduled';
-    /** Physical location */
-    location?: string | null;
-    /** Grade levels */
-    grades?: TimebackGrade[];
-    /** Subject areas */
-    subjects?: TimebackSubject[];
-    /** Subject codes */
-    subjectCodes?: string[];
-    /** Period/time slot identifiers */
-    periods?: string[];
-    /** Associated terms */
-    terms?: RefWithHref[];
-    /** Course this class is a section of */
-    course?: RefWithHref | null;
-    /** School where this class is held */
-    school?: RefWithHref | null;
-    /** Learning resources for this class */
-    resources?: RefWithHref[];
-}
-/**
- * Input for creating a new class.
- *
- * Uses simple Ref (just sourcedId) for references since href/type are not needed for creation.
- */
-export interface ClassCreateInput {
-    /** Client-supplied sourcedId (optional) */
-    sourcedId?: string;
-    /** Class title */
-    title: string;
-    /** Status */
-    status?: 'active' | 'tobedeleted';
-    /** Type of class */
-    classType?: 'homeroom' | 'scheduled';
-    /** Class code/section identifier */
-    classCode?: string | null;
-    /** Physical location */
-    location?: string | null;
-    /** Grade levels */
-    grades?: TimebackGrade[];
-    /** Subject areas */
-    subjects?: TimebackSubject[];
-    /** Subject codes */
-    subjectCodes?: string[];
-    /** Period/time slot identifiers */
-    periods?: string[];
-    /** Associated terms (required - at least one term reference) */
-    terms: Ref[];
-    /** Course this class is a section of */
-    course: Ref;
-    /** Organization (school) where this class is held */
-    org: Ref;
-    /** Learning resources for this class */
-    resources?: Ref[];
-}
-/**
- * Goals for an individual enrollment.
- */
-export interface EnrollmentGoals {
-    dailyXp?: number;
-    dailyLessons?: number;
-    dailyActiveMinutes?: number;
-    dailyAccuracy?: number;
-    dailyMasteredUnits?: number;
-}
-/**
- * Metrics for an enrollment.
- */
-export interface EnrollmentMetrics {
-    totalXp?: number;
-    totalLessons?: number;
-    totalGrades?: number;
-    courseType?: string;
-    isSupplemental?: boolean;
-}
-/**
- * Extended metadata for enrollments.
- */
-export interface EnrollmentMetadata extends Record<string, unknown> {
-    /** Individual learning goals */
-    goals?: EnrollmentGoals;
-    /** Progress metrics */
-    metrics?: EnrollmentMetrics;
-}
-/**
- * An enrollment linking a user to a class.
- *
- * Enrollments define the relationship between users and classes,
- * including their role (student, teacher) and the time period.
- */
-export interface Enrollment extends Omit<Base, 'metadata'> {
-    /** Enrollment-specific metadata with goals and metrics */
-    metadata?: EnrollmentMetadata | null;
-    /** The enrolled user */
-    user: RefWithHref & {
-        name?: string;
-    };
-    /** The class the user is enrolled in */
-    class: RefWithHref & {
-        name?: string;
-    };
-    /** The school */
-    school: RefWithHref & {
-        name?: string;
-    };
-    /** The course */
-    course: RefWithHref & {
-        name?: string;
-    };
-    /** Role in this enrollment (student, teacher, etc.) */
-    role: OneRosterUserRole;
-    /** Whether this is the user's primary class ("true"/"false") */
-    primary?: string | null;
-    /** Start date of enrollment */
-    beginDate?: string | null;
-    /** End date of enrollment */
-    endDate?: string | null;
-}
-/**
- * Input for creating or updating an enrollment.
- *
- * Uses simple refs (just sourcedId) instead of full RefWithHref.
- */
-export interface EnrollmentCreateInput {
-    /** Optional sourcedId (auto-generated if not provided) */
-    sourcedId?: string;
-    /** Status of the enrollment */
-    status?: 'active' | 'tobedeleted';
-    /** Enrollment metadata */
-    metadata?: EnrollmentMetadata | null;
-    /** The user to enroll */
-    user: Ref;
-    /** The class to enroll in */
-    class: Ref;
-    /** The school (optional) */
-    school?: Ref;
-    /** Role in this enrollment */
-    role: OneRosterUserRole;
-    /** Whether this is the user's primary class */
-    primary?: string | boolean;
-    /** Start date in YYYY-MM-DD format */
-    beginDate?: string;
-    /** End date in YYYY-MM-DD format */
-    endDate?: string;
-}
-/**
- * Input for enrolling a user in a class.
- */
-export interface EnrollInput {
-    /** User sourcedId to enroll */
-    sourcedId: string;
-    /** Role for this enrollment */
-    role: 'student' | 'teacher';
-    /** Whether this is the user's primary class */
-    primary?: boolean;
-    /** Start date in YYYY-MM-DD format */
-    beginDate?: string;
-    /** End date in YYYY-MM-DD format */
-    endDate?: string;
-}
-/**
- * An academic session such as a term, semester, or school year.
- *
- * Academic sessions define time periods for scheduling and can be
- * nested (e.g., terms within a school year).
- */
-export interface AcademicSession extends Base {
-    /** Session title (e.g., "Fall 2024") */
-    title: string;
-    /** Start date in YYYY-MM-DD format */
-    startDate: string;
-    /** End date in YYYY-MM-DD format */
-    endDate: string;
-    /** Type of session */
-    type: 'gradingPeriod' | 'semester' | 'schoolYear' | 'term';
-    /** Parent session reference */
-    parent?: RefWithHref | null;
-    /** School year as a number (e.g., 2024) */
-    schoolYear: number;
-    /** Organization this session belongs to */
-    org: RefWithHref;
-    /** Child sessions */
-    children?: RefWithHref[] | null;
-}
-/**
- * A term within an academic year.
- * Alias for AcademicSession with type 'term'.
- */
-export type Term = AcademicSession;
-/**
- * A grading period within a term or semester.
- * Alias for AcademicSession with type 'gradingPeriod'.
- */
-export type GradingPeriod = AcademicSession;
-/**
- * Input for creating/updating an academic session.
- * Uses simple Ref (just sourcedId) for references.
- */
-export interface AcademicSessionCreateInput {
-    /** Client-supplied sourcedId (required for academic sessions) */
-    sourcedId: string;
-    /** Status */
-    status: 'active' | 'tobedeleted';
-    /** Metadata */
-    metadata?: Record<string, unknown>;
-    /** Session title */
-    title: string;
-    /** Start date in YYYY-MM-DD format */
-    startDate: string;
-    /** End date in YYYY-MM-DD format */
-    endDate: string;
-    /** Type of session */
-    type: 'gradingPeriod' | 'semester' | 'schoolYear' | 'term';
-    /** Parent session reference (simple ref) */
-    parent?: Ref | null;
-    /** School year as string (e.g., "2024") */
-    schoolYear: string;
-    /** Organization reference (simple ref) */
-    org: Ref;
-    /** Child session references (these do require href/type per API) */
-    children?: RefWithHref[];
-}
-/**
- * Input for adding an agent (parent/guardian) relationship.
- */
-export interface AgentInput {
-    /** The sourcedId of the agent user (e.g., parent) */
-    agentSourcedId: string;
-}
-/**
- * Response from creating user credentials.
- */
-export interface CredentialCreateResponse {
-    /** The user profile ID */
-    userProfileId: string;
-    /** The created credential ID */
-    credentialId: string;
-    /** Status message */
-    message: string;
-}
-/**
- * Response from decrypting user credentials.
- */
-export interface DecryptedCredential {
-    /** The decrypted password */
-    password: string;
-}
-//# sourceMappingURL=rostering.d.ts.map