@timeback/oneroster 0.1.0

package/dist/resources/rostering/schools.d.ts

@@ -0,0 +1,214 @@
+/**
+ * Schools Resource
+ *
+ * Schools are a filtered view of organizations with nested resources.
+ */
+import { Paginator } from '../../lib';
+import type { ListParams } from '../../lib';
+import type { AcademicSession, AcademicSessionFilterFields, Class, ClassFilterFields, Course, CourseFilterFields, CreateResponse, Enrollment, EnrollmentFilterFields, LineItem, LineItemCreateInput, LineItemFilterFields, OneRosterTransportLike, Organization, SchoolsCallable, ScoreScale, ScoreScaleFilterFields, User, UserFilterFields } from '../../types';
+/**
+ * Scoped resource for a specific class within a school.
+ *
+ * Access via `client.schools(schoolId).class(classId)`.
+ *
+ * @example
+ * ```typescript
+ * const enrollments = await client.schools(schoolId).class(classId).enrollments()
+ * ```
+ */
+export declare class ScopedSchoolClassResource {
+    private readonly transport;
+    private readonly basePath;
+    constructor(transport: OneRosterTransportLike, schoolId: string, classId: string);
+    /**
+     * List enrollments for this class within this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to enrollment array
+     */
+    enrollments(params?: ListParams<EnrollmentFilterFields>): Promise<Enrollment[]>;
+    /**
+     * Stream enrollments with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming enrollments
+     */
+    streamEnrollments(params?: ListParams<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
+    /**
+     * List students in this class at this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to user array
+     */
+    students(params?: ListParams<UserFilterFields>): Promise<User[]>;
+    /**
+     * Stream students with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming students
+     */
+    streamStudents(params?: ListParams<UserFilterFields>): Paginator<User, UserFilterFields>;
+    /**
+     * List teachers for this class at this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to user array
+     */
+    teachers(params?: ListParams<UserFilterFields>): Promise<User[]>;
+    /**
+     * Stream teachers with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming teachers
+     */
+    streamTeachers(params?: ListParams<UserFilterFields>): Paginator<User, UserFilterFields>;
+}
+/**
+ * Scoped resource for operations on a specific school.
+ *
+ * Access via `client.schools(schoolId)`.
+ *
+ * @example
+ * ```typescript
+ * const school = await client.schools(schoolId).get()
+ * const classes = await client.schools(schoolId).classes()
+ * const students = await client.schools(schoolId).students()
+ * const teachers = await client.schools(schoolId).teachers()
+ * const lineItems = await client.schools(schoolId).lineItems()
+ * const enrollments = await client.schools(schoolId).class(classId).enrollments()
+ * ```
+ */
+export declare class ScopedSchoolResource {
+    private readonly transport;
+    private readonly basePath;
+    private readonly gradebookPath;
+    private readonly schoolId;
+    constructor(transport: OneRosterTransportLike, schoolId: string);
+    /**
+     * Get the school details.
+     * @returns The organization/school object
+     */
+    get(): Promise<Organization>;
+    /**
+     * Scope to a specific class within this school.
+     * @param classId - The class sourcedId
+     * @returns Scoped class resource for school-class operations
+     */
+    class(classId: string): ScopedSchoolClassResource;
+    /**
+     * List classes in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to class array
+     */
+    classes(params?: ListParams<ClassFilterFields>): Promise<Class[]>;
+    /**
+     * Stream classes with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming classes
+     */
+    streamClasses(params?: ListParams<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
+    /**
+     * List enrollments in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to enrollment array
+     */
+    enrollments(params?: ListParams<EnrollmentFilterFields>): Promise<Enrollment[]>;
+    /**
+     * Stream enrollments with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming enrollments
+     */
+    streamEnrollments(params?: ListParams<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
+    /**
+     * List students in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to user array
+     */
+    students(params?: ListParams<UserFilterFields>): Promise<User[]>;
+    /**
+     * Stream students with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming students
+     */
+    streamStudents(params?: ListParams<UserFilterFields>): Paginator<User, UserFilterFields>;
+    /**
+     * List teachers in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to user array
+     */
+    teachers(params?: ListParams<UserFilterFields>): Promise<User[]>;
+    /**
+     * Stream teachers with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming teachers
+     */
+    streamTeachers(params?: ListParams<UserFilterFields>): Paginator<User, UserFilterFields>;
+    /**
+     * List courses in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to course array
+     */
+    courses(params?: ListParams<CourseFilterFields>): Promise<Course[]>;
+    /**
+     * Stream courses with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming courses
+     */
+    streamCourses(params?: ListParams<CourseFilterFields>): Paginator<Course, CourseFilterFields>;
+    /**
+     * List terms/academic sessions for this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to academic session array
+     */
+    terms(params?: ListParams<AcademicSessionFilterFields>): Promise<AcademicSession[]>;
+    /**
+     * Stream terms with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming academic sessions
+     */
+    streamTerms(params?: ListParams<AcademicSessionFilterFields>): Paginator<AcademicSession, AcademicSessionFilterFields>;
+    /**
+     * List line items (assignments) in this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to line item array
+     */
+    lineItems(params?: ListParams<LineItemFilterFields>): Promise<LineItem[]>;
+    /**
+     * Stream line items with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming line items
+     */
+    streamLineItems(params?: ListParams<LineItemFilterFields>): Paginator<LineItem, LineItemFilterFields>;
+    /**
+     * Create a line item (assignment) in this school.
+     *
+     * @param data - Line item data
+     * @returns Create response with sourcedIdPairs
+     * @example
+     * ```typescript
+     * await client.schools(schoolId).createLineItem({
+     *   title: 'Homework 1',
+     *   class: { sourcedId: classId },
+     *   school: { sourcedId: schoolId },
+     *   category: { sourcedId: categoryId },
+     *   assignDate: '2024-12-20',
+     *   dueDate: '2024-12-27',
+     *   status: 'active',
+     * })
+     * ```
+     */
+    createLineItem(data: LineItemCreateInput): Promise<CreateResponse>;
+    /**
+     * List score scales for this school.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to score scale array
+     */
+    scoreScales(params?: ListParams<ScoreScaleFilterFields>): Promise<ScoreScale[]>;
+    /**
+     * Stream score scales with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming score scales
+     */
+    streamScoreScales(params?: ListParams<ScoreScaleFilterFields>): Paginator<ScoreScale, ScoreScaleFilterFields>;
+}
+/**
+ * Create a callable schools resource.
+ * @param transport - OneRoster transport instance
+ * @returns Callable resource for schools
+ */
+export declare function createSchoolsResource(transport: OneRosterTransportLike): SchoolsCallable;
+//# sourceMappingURL=schools.d.ts.map

package/dist/resources/rostering/schools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schools.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/schools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAIrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EACX,eAAe,EACf,2BAA2B,EAC3B,KAAK,EACL,iBAAiB,EACjB,MAAM,EACN,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,sBAAsB,EACtB,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EAGZ,eAAe,EACf,UAAU,EACV,sBAAsB,EACtB,IAAI,EACJ,gBAAgB,EAChB,MAAM,aAAa,CAAA;AAMpB;;;;;;;;;GASG;AACH,qBAAa,yBAAyB;IAIpC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAGf;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAE9E;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GACzC,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAE/D;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOvF;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAE/D;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOvF;CACD;AAMD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAoB;IAM/B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAL3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,QAAQ,EAAE,MAAM,EAKhB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,CAGjC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAEhD;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEhE;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOzF;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAE9E;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GACzC,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAE/D;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOvF;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAE/D;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOvF;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAElE;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAO5F;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAElF;IAED;;;;OAIG;IACH,WAAW,CACV,MAAM,CAAC,EAAE,UAAU,CAAC,2BAA2B,CAAC,GAC9C,SAAS,CAAC,eAAe,EAAE,2BAA2B,CAAC,CAYzD;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,eAAe,CACd,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,GACvC,SAAS,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAO3C;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAKjE;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAE9E;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GACzC,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;CACD;AA6BD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,sBAAsB,GAAG,eAAe,CAaxF"}

package/dist/resources/rostering/users.d.ts

@@ -0,0 +1,191 @@
+/**
+ * Users Resource
+ *
+ * Access all users regardless of role.
+ */
+import { Paginator } from '../../lib';
+import type { ListParams } from '@timeback/internal-client-infra';
+import type { AgentInput, Class, ClassFilterFields, CredentialCreateResponse, DecryptedCredential, OneRosterTransportLike, Resource, ResourceFilterFields, StudentsCallable, TeachersCallable, User, UserProfileCredential, UsersCallable } from '../../types';
+/**
+ * Scoped resource for operations on a specific user.
+ *
+ * Access via `client.users(userId)`.
+ *
+ * @example
+ * ```typescript
+ * const user = await client.users(userId).get()
+ * const resources = await client.users(userId).resources()
+ * ```
+ */
+export declare class ScopedUserResource {
+    private readonly transport;
+    private readonly basePath;
+    private readonly userId;
+    constructor(transport: OneRosterTransportLike, userId: string);
+    /**
+     * Get the user details.
+     * @returns The user object
+     */
+    get(): Promise<User>;
+    /**
+     * Get the user with their demographic information.
+     *
+     * Returns the user object with the `demographics` field populated.
+     *
+     * @returns The user object with demographics
+     */
+    demographics(): Promise<User>;
+    /**
+     * List resources for this user.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to resource array
+     */
+    resources(params?: ListParams<ResourceFilterFields>): Promise<Resource[]>;
+    /**
+     * Stream resources with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming resources
+     */
+    streamResources(params?: ListParams<ResourceFilterFields>): Paginator<Resource, ResourceFilterFields>;
+    /**
+     * List classes for this user.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to class array
+     */
+    classes(params?: ListParams<ClassFilterFields>): Promise<Class[]>;
+    /**
+     * Stream classes with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming classes
+     */
+    streamClasses(params?: ListParams<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
+    /**
+     * Get users that this user is an agent (guardian/parent) for.
+     *
+     * For example, if this user is a parent, returns their children.
+     *
+     * @returns Array of users this user represents
+     */
+    agentFor(): Promise<User[]>;
+    /**
+     * Get agents (guardians/parents) for this user.
+     *
+     * For example, if this user is a student, returns their parents/guardians.
+     *
+     * @returns Array of agent users
+     */
+    agents(): Promise<User[]>;
+    /**
+     * Add an agent (guardian/parent) relationship for this user.
+     *
+     * @param data - Agent input with the agent user reference
+     * @returns Promise resolving when complete
+     */
+    addAgent(data: AgentInput): Promise<void>;
+    /**
+     * Remove an agent (guardian/parent) relationship from this user.
+     *
+     * @param agentSourcedId - The sourcedId of the agent to remove
+     * @returns Promise resolving when complete
+     */
+    removeAgent(agentSourcedId: string): Promise<void>;
+    /**
+     * Create credentials for this user.
+     *
+     * @param credential - Credential data to create
+     * @returns Response with userProfileId, credentialId, and message
+     */
+    createCredential(credential: Partial<UserProfileCredential>): Promise<CredentialCreateResponse>;
+    /**
+     * Decrypt a user's credential to retrieve the password.
+     *
+     * @param credentialId - The credential ID to decrypt
+     * @returns Decrypted credential with password
+     */
+    decryptCredential(credentialId: string): Promise<DecryptedCredential>;
+}
+/**
+ * Create a callable users resource.
+ * @param transport - OneRoster transport instance
+ * @returns Callable resource for users
+ */
+export declare function createUsersResource(transport: OneRosterTransportLike): UsersCallable;
+/**
+ * Scoped resource for operations on a specific student.
+ *
+ * Access via `client.students(studentId)`.
+ *
+ * @example
+ * ```typescript
+ * const student = await client.students(studentId).get()
+ * const classes = await client.students(studentId).classes()
+ * ```
+ */
+export declare class ScopedStudentResource {
+    private readonly transport;
+    private readonly basePath;
+    constructor(transport: OneRosterTransportLike, studentId: string);
+    /**
+     * Get the student details.
+     * @returns The user object
+     */
+    get(): Promise<User>;
+    /**
+     * List classes this student is enrolled in.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to class array
+     */
+    classes(params?: ListParams<ClassFilterFields>): Promise<Class[]>;
+    /**
+     * Stream classes with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming classes
+     */
+    streamClasses(params?: ListParams<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
+}
+/**
+ * Scoped resource for operations on a specific teacher.
+ *
+ * Access via `client.teachers(teacherId)`.
+ *
+ * @example
+ * ```typescript
+ * const teacher = await client.teachers(teacherId).get()
+ * const classes = await client.teachers(teacherId).classes()
+ * ```
+ */
+export declare class ScopedTeacherResource {
+    private readonly transport;
+    private readonly basePath;
+    constructor(transport: OneRosterTransportLike, teacherId: string);
+    /**
+     * Get the teacher details.
+     * @returns The user object
+     */
+    get(): Promise<User>;
+    /**
+     * List classes this teacher is assigned to.
+     * @param params - Optional filter and pagination parameters
+     * @returns Promise resolving to class array
+     */
+    classes(params?: ListParams<ClassFilterFields>): Promise<Class[]>;
+    /**
+     * Stream classes with lazy pagination.
+     * @param params - Optional filter and pagination parameters
+     * @returns Paginator for streaming classes
+     */
+    streamClasses(params?: ListParams<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
+}
+/**
+ * Create a callable students resource.
+ * @param transport - OneRoster transport instance
+ * @returns Callable resource for students
+ */
+export declare function createStudentsResource(transport: OneRosterTransportLike): StudentsCallable;
+/**
+ * Create a callable teachers resource.
+ * @param transport - OneRoster transport instance
+ * @returns Callable resource for teachers
+ */
+export declare function createTeachersResource(transport: OneRosterTransportLike): TeachersCallable;
+//# sourceMappingURL=users.d.ts.map

package/dist/resources/rostering/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAIrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,KAAK,EACX,UAAU,EACV,KAAK,EACL,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,IAAI,EAGJ,qBAAqB,EACrB,aAAa,EACb,MAAM,aAAa,CAAA;AAMpB;;;;;;;;;;GAUG;AACH,qBAAa,kBAAkB;IAK7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAJ3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B,YACkB,SAAS,EAAE,sBAAsB,EAClD,MAAM,EAAE,MAAM,EAId;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CASlC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,eAAe,CACd,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,GACvC,SAAS,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAO3C;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEhE;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOzF;IAID;;;;;;OAMG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAShC;IAED;;;;;;OAMG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAO9B;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxC;IAED;;;;;OAKG;IACH,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjD;IAID;;;;;OAKG;IACH,gBAAgB,CACf,UAAU,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACxC,OAAO,CAAC,wBAAwB,CAAC,CAKnC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAKpE;CACD;AAwCD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,sBAAsB,GAAG,aAAa,CAapF;AAUD;;;;;;;;;;GAUG;AACH,qBAAa,qBAAqB;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,SAAS,EAAE,MAAM,EAGjB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEhE;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOzF;CACD;AAMD;;;;;;;;;;GAUG;AACH,qBAAa,qBAAqB;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,SAAS,EAAE,MAAM,EAGjB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEhE;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOzF;CACD;AA6BD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,sBAAsB,GAAG,gBAAgB,CAU1F;AA6BD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,sBAAsB,GAAG,gBAAgB,CAU1F"}

package/dist/types/base.d.ts

@@ -0,0 +1,127 @@
+/**
+ * OneRoster Base Types
+ *
+ * Common types used across all OneRoster entities.
+ * Primitives (TimebackSubject, TimebackGrade, etc.) come from `@timeback/types`.
+ */
+export type { IMSErrorResponse, LessonType, OneRosterUserRole, OrganizationType, ScoreStatus, TimebackGrade, TimebackSubject, } from '@timeback/types';
+/**
+ * Base interface for all OneRoster entities.
+ *
+ * All OneRoster resources share these common fields for identification,
+ * status tracking, and extensibility.
+ */
+export interface Base {
+    /**
+     * Globally unique identifier for the entity.
+     * Typically a UUID assigned by the source system.
+     */
+    sourcedId?: string;
+    /**
+     * The status of the entity.
+     * - `active`: Entity is current and valid
+     * - `tobedeleted`: Entity is marked for deletion
+     */
+    status?: 'active' | 'tobedeleted';
+    /**
+     * ISO 8601 timestamp of the last modification.
+     * @example "2024-01-15T10:30:00Z"
+     */
+    dateLastModified?: string;
+    /**
+     * Extensible metadata object for custom properties.
+     * Used for vendor-specific extensions.
+     */
+    metadata?: Record<string, unknown> | null;
+}
+/**
+ * A score for a specific learning objective.
+ */
+export interface LearningObjectiveResult {
+    /** Identifier of the learning objective */
+    learningObjectiveId: string;
+    /** Numeric score */
+    score?: number;
+    /** Text-based score (e.g., "Proficient") */
+    textScore?: string;
+}
+/**
+ * A set of learning objectives with optional results.
+ */
+export interface LearningObjectiveSetItem {
+    /** Source system for these learning objectives */
+    source: string;
+    /** Learning objective IDs (for line items) */
+    learningObjectiveIds?: string[];
+    /** Learning objective results (for results) */
+    learningObjectiveResults?: LearningObjectiveResult[];
+}
+/**
+ * Array of learning objective sets, or null if not applicable.
+ */
+export type LearningObjectiveSet = LearningObjectiveSetItem[] | null;
+/**
+ * A reference to another OneRoster entity by sourcedId.
+ */
+export interface Ref {
+    /** The sourcedId of the referenced entity */
+    sourcedId: string;
+}
+/**
+ * A reference with an optional type discriminator.
+ */
+export interface RefWithType extends Ref {
+    /** The type of the referenced entity (e.g., "user", "class") */
+    type?: string;
+}
+/**
+ * A fully-qualified reference with href and type.
+ * Commonly returned in API responses for navigable links.
+ */
+export interface RefWithHref extends Ref {
+    /** The URL to fetch the referenced entity */
+    href: string;
+    /** The type of the referenced entity */
+    type: string;
+}
+/**
+ * Response returned when creating a new entity.
+ * Contains the mapping between supplied and allocated IDs.
+ */
+export interface CreateResponse {
+    sourcedIdPairs: {
+        /** The sourcedId provided in the create request */
+        suppliedSourcedId: string;
+        /** The sourcedId allocated by the server (may differ) */
+        allocatedSourcedId: string;
+    };
+}
+/**
+ * Common interface for resources that support streaming/listing.
+ *
+ * All OneRoster resource classes implement this interface, allowing
+ * generic code to work with any resource type.
+ *
+ * @typeParam T - The entity type returned by the resource
+ */
+export interface StreamableResource<T = unknown> {
+    /**
+     * List all resources, fetching all pages automatically.
+     * @returns Promise resolving to an array of all matching resources
+     */
+    list(params?: Record<string, unknown>): Promise<T[]>;
+    /**
+     * Stream resources with lazy pagination.
+     * @returns Async iterable for streaming results
+     */
+    stream(params?: Record<string, unknown>): AsyncIterable<T>;
+    /**
+     * Get a single resource by sourcedId.
+     */
+    get(sourcedId: string): Promise<T>;
+}
+/**
+ * Re-export ToArrayOptions from client-common.
+ */
+export type { ToArrayOptions } from '@timeback/internal-client-infra';
+//# sourceMappingURL=base.d.ts.map

package/dist/types/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,YAAY,EACX,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,eAAe,GACf,MAAM,iBAAiB,CAAA;AAExB;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAA;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,2CAA2C;IAC3C,mBAAmB,EAAE,MAAM,CAAA;IAC3B,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAA;IACd,8CAA8C;IAC9C,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B,+CAA+C;IAC/C,wBAAwB,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACpD;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,wBAAwB,EAAE,GAAG,IAAI,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,GAAG;IACnB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,GAAG;IACvC,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,GAAG;IACvC,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE;QACf,mDAAmD;QACnD,iBAAiB,EAAE,MAAM,CAAA;QACzB,yDAAyD;QACzD,kBAAkB,EAAE,MAAM,CAAA;KAC1B,CAAA;CACD;AAMD;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO;IAC9C;;;OAGG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IAEpD;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;IAE1D;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAClC;AAMD;;GAEG;AACH,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA"}