@timeback/oneroster 0.1.0

package/dist/types/callable.d.ts

@@ -0,0 +1,246 @@
+/**
+ * Callable Resource Types
+ *
+ * Types for callable resource patterns where
+ * `resource(id)` returns a scoped resource and `resource.list()` etc.
+ * access collection-level operations.
+ */
+import type { ListParams } from '@timeback/internal-client-infra';
+import type { Paginator } from '../lib';
+import type { ScopedAssessmentLineItemResource } from '../resources/assessment/line-items';
+import type { ScopedLineItemResource } from '../resources/gradebook/line-items';
+import type { ScopedResourceResource } from '../resources/resources/resources';
+import type { ScopedTermResource } from '../resources/rostering/academic-sessions';
+import type { ScopedClassResource } from '../resources/rostering/classes';
+import type { ScopedCourseResource } from '../resources/rostering/courses';
+import type { ScopedSchoolResource } from '../resources/rostering/schools';
+import type { ScopedStudentResource, ScopedTeacherResource, ScopedUserResource } from '../resources/rostering/users';
+import type { Base } from './base';
+import type { AcademicSession, AcademicSessionFilterFields, AssessmentLineItem, AssessmentLineItemFilterFields, Class, ClassCreateInput, ClassFilterFields, ComponentResource, ComponentResourceCreateInput, ComponentResourceFilterFields, Course, CourseComponent, CourseComponentCreateInput, CourseComponentFilterFields, CourseCreateInput, CourseFilterFields, CourseStructureInput, CreateResponse, LineItem, LineItemCreateInput, LineItemFilterFields, Organization, OrganizationFilterFields, Resource, ResourceFilterFields, SchoolCreateInput, User, UserCreateInput, UserFilterFields } from './index';
+/**
+ * Base interface for callable resources.
+ * Resources that support scoping by ID implement this pattern.
+ *
+ * @template T - The entity type
+ * @template F - Filter fields type
+ * @template S - Scoped resource type returned when called with an ID
+ * @template I - Input type for create/update (defaults to Partial<T>)
+ */
+export interface CallableResource<T extends Base, F, S, I = Partial<T>> {
+    /** Get a scoped resource for a specific entity */
+    (id: string): S;
+    /** List all entities */
+    list(params?: ListParams<F>): Promise<T[]>;
+    /** Stream entities with lazy pagination */
+    stream(params?: ListParams<F>): Paginator<T, F>;
+    /** Get a single entity by ID */
+    get(id: string): Promise<T>;
+    /** Create a new entity */
+    create(data: I): Promise<CreateResponse>;
+    /** Update an existing entity */
+    update(id: string, data: Partial<I>): Promise<void>;
+    /** Delete an entity */
+    delete(id: string): Promise<void>;
+}
+/**
+ * Read-only callable resource (no create/update/delete).
+ *
+ * @template T - The entity type
+ * @template F - Filter fields type
+ * @template S - Scoped resource type returned when called with an ID
+ */
+export interface ReadOnlyCallableResource<T extends Base, F, S> {
+    /** Get a scoped resource for a specific entity */
+    (id: string): S;
+    /** List all entities */
+    list(params?: ListParams<F>): Promise<T[]>;
+    /** Stream entities with lazy pagination */
+    stream(params?: ListParams<F>): Paginator<T, F>;
+    /** Get a single entity by ID */
+    get(id: string): Promise<T>;
+}
+/**
+ * Callable courses resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const courses = await client.courses.list()
+ * const course = await client.courses.get(id)
+ *
+ * // Scoped operations
+ * const classes = await client.courses(courseId).classes()
+ * ```
+ */
+export interface CoursesCallable extends CallableResource<Course, CourseFilterFields, ScopedCourseResource, CourseCreateInput> {
+    /** List all course components */
+    components(params?: ListParams<CourseComponentFilterFields>): Promise<CourseComponent[]>;
+    /** Stream course components with lazy pagination */
+    streamComponents(params?: ListParams<CourseComponentFilterFields>): Paginator<CourseComponent, CourseComponentFilterFields>;
+    /** Get a specific course component */
+    getComponent(sourcedId: string): Promise<CourseComponent>;
+    /** Create a new course component */
+    createComponent(data: CourseComponentCreateInput): Promise<CreateResponse>;
+    /** Update a course component */
+    updateComponent(sourcedId: string, data: Partial<CourseComponent>): Promise<void>;
+    /** Delete a course component */
+    deleteComponent(sourcedId: string): Promise<void>;
+    /** List all component resources */
+    componentResources(params?: ListParams<ComponentResourceFilterFields>): Promise<ComponentResource[]>;
+    /** Stream component resources with lazy pagination */
+    streamComponentResources(params?: ListParams<ComponentResourceFilterFields>): Paginator<ComponentResource, ComponentResourceFilterFields>;
+    /** Get a specific component resource */
+    getComponentResource(sourcedId: string): Promise<ComponentResource>;
+    /** Create a new component resource */
+    createComponentResource(data: ComponentResourceCreateInput): Promise<CreateResponse>;
+    /** Update a component resource */
+    updateComponentResource(sourcedId: string, data: Partial<ComponentResource>): Promise<void>;
+    /** Delete a component resource */
+    deleteComponentResource(sourcedId: string): Promise<void>;
+    /** Create a course structure from QTI tests */
+    createStructure(data: CourseStructureInput): Promise<CreateResponse>;
+}
+/**
+ * Callable classes resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const classes = await client.classes.list()
+ * const cls = await client.classes.get(id)
+ *
+ * // Scoped operations
+ * const students = await client.classes(classId).students()
+ * const lineItems = await client.classes(classId).lineItems()
+ * ```
+ */
+export type ClassesCallable = CallableResource<Class, ClassFilterFields, ScopedClassResource, ClassCreateInput>;
+/**
+ * Callable schools resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const schools = await client.schools.list()
+ * const school = await client.schools.get(id)
+ *
+ * // Scoped operations
+ * const classes = await client.schools(schoolId).classes()
+ * const students = await client.schools(schoolId).students()
+ * ```
+ */
+export type SchoolsCallable = CallableResource<Organization, OrganizationFilterFields, ScopedSchoolResource, SchoolCreateInput>;
+/**
+ * Callable users resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const users = await client.users.list()
+ * const user = await client.users.get(id)
+ *
+ * // Scoped operations
+ * const resources = await client.users(userId).resources()
+ * const classes = await client.users(userId).classes()
+ * ```
+ */
+export type UsersCallable = CallableResource<User, UserFilterFields, ScopedUserResource, UserCreateInput>;
+/**
+ * Callable students resource (read-only).
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const students = await client.students.list()
+ * const student = await client.students.get(id)
+ *
+ * // Scoped operations
+ * const classes = await client.students(studentId).classes()
+ * ```
+ */
+export type StudentsCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedStudentResource>;
+/**
+ * Callable teachers resource (read-only).
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const teachers = await client.teachers.list()
+ * const teacher = await client.teachers.get(id)
+ *
+ * // Scoped operations
+ * const classes = await client.teachers(teacherId).classes()
+ * ```
+ */
+export type TeachersCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedTeacherResource>;
+/**
+ * Callable terms resource (read-only).
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const terms = await client.terms.list()
+ * const term = await client.terms.get(id)
+ *
+ * // Scoped operations
+ * const classes = await client.terms(termId).classes()
+ * ```
+ */
+export type TermsCallable = ReadOnlyCallableResource<AcademicSession, AcademicSessionFilterFields, ScopedTermResource>;
+/**
+ * Callable line items resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const lineItems = await client.lineItems.list()
+ * const lineItem = await client.lineItems.get(id)
+ *
+ * // Scoped operations
+ * const results = await client.lineItems(lineItemId).results()
+ * ```
+ */
+export interface LineItemsCallable extends CallableResource<LineItem, LineItemFilterFields, ScopedLineItemResource> {
+    /** Create a new line item */
+    create(data: LineItemCreateInput): Promise<CreateResponse>;
+}
+/**
+ * Callable assessment line items resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const lineItems = await client.assessmentLineItems.list()
+ * const lineItem = await client.assessmentLineItems.get(id)
+ *
+ * // Partial update
+ * await client.assessmentLineItems.patch(id, { score: 95 })
+ * ```
+ */
+export interface AssessmentLineItemsCallable extends CallableResource<AssessmentLineItem, AssessmentLineItemFilterFields, ScopedAssessmentLineItemResource> {
+    /** Partially update an assessment line item (only specified fields are changed) */
+    patch(id: string, data: Partial<AssessmentLineItem>): Promise<void>;
+}
+/**
+ * Callable resources resource.
+ *
+ * @example
+ * ```typescript
+ * // Collection operations
+ * const resources = await client.resources.list()
+ * const resource = await client.resources.get(id)
+ *
+ * // Nested resource queries (following convention)
+ * const classResources = await client.classes(classId).resources()
+ * const courseResources = await client.courses(courseId).resources()
+ * const userResources = await client.users(userId).resources()
+ *
+ * // Export
+ * await client.resources.export(resourceId)
+ * ```
+ */
+export interface ResourcesCallable extends CallableResource<Resource, ResourceFilterFields, ScopedResourceResource> {
+    /** Export a resource to Common Cartridge (.zip) as an ArrayBuffer */
+    export(resourceId: string): Promise<ArrayBuffer>;
+}
+//# sourceMappingURL=callable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"callable.d.ts","sourceRoot":"","sources":["../../src/types/callable.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAA;AAC1F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EACX,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,KAAK,EACX,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,8BAA8B,EAC9B,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,6BAA6B,EAC7B,MAAM,EACN,eAAe,EACf,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,wBAAwB,EACxB,QAAQ,EACR,oBAAoB,EACpB,iBAAiB,EACjB,IAAI,EACJ,eAAe,EACf,gBAAgB,EAChB,MAAM,SAAS,CAAA;AAMhB;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IACrE,kDAAkD;IAClD,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAA;IAEf,wBAAwB;IACxB,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,2CAA2C;IAC3C,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE/C,gCAAgC;IAChC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAE3B,0BAA0B;IAC1B,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAExC,gCAAgC;IAChC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnD,uBAAuB;IACvB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;IAC7D,kDAAkD;IAClD,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAA;IAEf,wBAAwB;IACxB,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IAE1C,2CAA2C;IAC3C,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE/C,gCAAgC;IAChC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC3B;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB,CACxD,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,CACjB;IACA,iCAAiC;IACjC,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAExF,oDAAoD;IACpD,gBAAgB,CACf,MAAM,CAAC,EAAE,UAAU,CAAC,2BAA2B,CAAC,GAC9C,SAAS,CAAC,eAAe,EAAE,2BAA2B,CAAC,CAAA;IAE1D,sCAAsC;IACtC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEzD,oCAAoC;IACpC,eAAe,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1E,gCAAgC;IAChC,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjF,gCAAgC;IAChC,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjD,mCAAmC;IACnC,kBAAkB,CACjB,MAAM,CAAC,EAAE,UAAU,CAAC,6BAA6B,CAAC,GAChD,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAE/B,sDAAsD;IACtD,wBAAwB,CACvB,MAAM,CAAC,EAAE,UAAU,CAAC,6BAA6B,CAAC,GAChD,SAAS,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,CAAA;IAE9D,wCAAwC;IACxC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAEnE,sCAAsC;IACtC,uBAAuB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAEpF,kCAAkC;IAClC,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3F,kCAAkC;IAClC,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzD,+CAA+C;IAC/C,eAAe,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CACpE;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAC7C,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,CAChB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAC7C,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EACpB,iBAAiB,CACjB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAC3C,IAAI,EACJ,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,CACf,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CACtD,IAAI,EACJ,gBAAgB,EAChB,qBAAqB,CACrB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CACtD,IAAI,EACJ,gBAAgB,EAChB,qBAAqB,CACrB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,GAAG,wBAAwB,CACnD,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,CAClB,CAAA;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CAC1D,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,CACtB;IACA,6BAA6B;IAC7B,MAAM,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CAC1D;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB,CACpE,kBAAkB,EAClB,8BAA8B,EAC9B,gCAAgC,CAChC;IACA,mFAAmF;IACnF,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnE;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CAC1D,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,CACtB;IACA,qEAAqE;IACrE,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAChD"}

package/dist/types/client.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Client Configuration Types
+ *
+ * Types for configuring the OneRoster client.
+ */
+import type { BaseTransportConfig, ClientConfig, OneRosterPaths, PaginatedResponse, ProviderClientConfig, RequestOptions, ResolvedProvider, TransportOnlyConfig } from '@timeback/internal-client-infra';
+export type { Environment, EnvAuth, ExplicitAuth, Platform } from '@timeback/internal-client-infra';
+export type { TimebackProvider, ProviderAuth } from '@timeback/internal-client-infra';
+/**
+ * Transport interface for OneRoster client.
+ *
+ * Extends base transport requirements with OneRoster-specific paths and pagination.
+ * Required when using transport mode with OneRosterClient.
+ */
+export interface OneRosterTransportLike {
+    /** Base URL of the API */
+    baseUrl: string;
+    /** API path profiles for OneRoster operations */
+    paths: OneRosterPaths;
+    /** Make an authenticated request */
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+    /** Make a raw request, returning the Response object (useful for binary responses) */
+    requestRaw(path: string, options?: RequestOptions): Promise<Response>;
+    /** Make a paginated request using header-based pagination */
+    requestPaginated<T>(path: string, options?: RequestOptions): Promise<PaginatedResponse<T>>;
+}
+/**
+ * Configuration options for creating a OneRosterClient.
+ *
+ * Accepts one of six mutually exclusive modes:
+ * 1. **Provider**: Provide a pre-built `TimebackProvider` instance
+ * 2. **Explicit**: Provide `baseUrl` and `auth` with `authUrl`
+ * 3. **Environment**: Provide `platform?`, `env` and `auth` (URLs derived automatically)
+ * 4. **Token Provider**: Provide `platform?`, `env` and `tokenProvider` (shared auth)
+ * 5. **Transport**: Provide a pre-configured `transport` instance with paths
+ * 6. **Env Vars**: Omit config entirely (reads from environment variables)
+ *
+ * The `platform` field selects which Timeback implementation to use:
+ * - `'BEYOND_AI'` (default): BeyondAI's Timeback platform
+ * - `'LEARNWITH_AI'`: Samy's LearnWith.ai platform
+ */
+export type OneRosterClientConfig = ClientConfig | TransportOnlyConfig<OneRosterTransportLike> | ProviderClientConfig;
+/**
+ * Configuration for OneRoster transport.
+ */
+export type OneRosterTransportConfig = BaseTransportConfig & {
+    /** API path profiles for OneRoster operations */
+    paths: OneRosterPaths;
+};
+/**
+ * Resolved provider type for OneRoster client.
+ */
+export type OneRosterResolvedProvider = ResolvedProvider<OneRosterTransportLike>;
+/**
+ * Instance type of OneRosterClient.
+ */
+export type OneRosterClientInstance = InstanceType<typeof import('../client').OneRosterClient>;
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/types/client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,iCAAiC,CAAA;AAExC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAA;AACnG,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAErF;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACtC,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,KAAK,EAAE,cAAc,CAAA;IACrB,oCAAoC;IACpC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC9D,sFAAsF;IACtF,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACrE,6DAA6D;IAC7D,gBAAgB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;CAC1F;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,qBAAqB,GAC9B,YAAY,GACZ,mBAAmB,CAAC,sBAAsB,CAAC,GAC3C,oBAAoB,CAAA;AAEvB;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAC5D,iDAAiD;IACjD,KAAK,EAAE,cAAc,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAA;AAEhF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC,cAAc,WAAW,EAAE,eAAe,CAAC,CAAA"}

package/dist/types/filters.d.ts

@@ -0,0 +1,165 @@
+/**
+ * Filter Field Types
+ *
+ * These types define the server-side filterable fields for each OneRoster entity.
+ * They may differ from the entity structure (e.g., `role` vs `roles`).
+ */
+import type { OneRosterUserRole, OrganizationType } from '@timeback/types';
+/**
+ * Base fields available for filtering on all entities.
+ */
+export interface BaseFilterFields {
+    sourcedId: string;
+    status: 'active' | 'tobedeleted';
+    dateLastModified: Date;
+}
+/**
+ * Filterable fields for User entities.
+ *
+ * Note: The server accepts `role` (singular) even though the entity has `roles` (array).
+ */
+export interface UserFilterFields extends BaseFilterFields {
+    givenName: string;
+    familyName: string;
+    email: string;
+    username: string;
+    enabledUser: string;
+    identifier: string;
+    userMasterIdentifier: string;
+    /** Server accepts singular `role` for filtering, even though entity has `roles` array */
+    role: OneRosterUserRole;
+}
+/**
+ * Filterable fields for Organization/School entities.
+ */
+export interface OrganizationFilterFields extends BaseFilterFields {
+    name: string;
+    identifier: string;
+    type: OrganizationType;
+}
+/**
+ * Filterable fields for Class entities.
+ */
+export interface ClassFilterFields extends BaseFilterFields {
+    title: string;
+    classCode: string;
+    classType: 'homeroom' | 'scheduled';
+    location: string;
+    grades: string;
+}
+/**
+ * Filterable fields for Course entities.
+ */
+export interface CourseFilterFields extends BaseFilterFields {
+    title: string;
+    courseCode: string;
+    grades: string;
+    subjects: string;
+}
+/**
+ * Filterable fields for Enrollment entities.
+ */
+export interface EnrollmentFilterFields extends BaseFilterFields {
+    role: OneRosterUserRole;
+    primary: string;
+    beginDate: Date;
+    endDate: Date;
+    'class.sourcedId': string;
+}
+/**
+ * Filterable fields for AcademicSession entities.
+ */
+export interface AcademicSessionFilterFields extends BaseFilterFields {
+    title: string;
+    type: 'gradingPeriod' | 'semester' | 'schoolYear' | 'term';
+    startDate: Date;
+    endDate: Date;
+    schoolYear: string;
+}
+/**
+ * Filterable fields for LineItem (gradebook) entities.
+ */
+export interface LineItemFilterFields extends BaseFilterFields {
+    title: string;
+    description: string;
+    assignDate: Date;
+    dueDate: Date;
+}
+/**
+ * Filterable fields for Result (grade) entities.
+ */
+export interface ResultFilterFields extends BaseFilterFields {
+    score: number;
+    scoreDate: Date;
+    scoreStatus: 'exempt' | 'fully graded' | 'not submitted' | 'partially graded' | 'submitted';
+}
+/**
+ * Filterable fields for Resource entities.
+ */
+export interface ResourceFilterFields extends BaseFilterFields {
+    title: string;
+    vendorResourceId: string;
+    importance: 'primary' | 'secondary';
+}
+/**
+ * Filterable fields for CourseComponent entities.
+ */
+export interface CourseComponentFilterFields extends BaseFilterFields {
+    title: string;
+    resourceType: string;
+    'course.sourcedId': string;
+}
+/**
+ * Filterable fields for ComponentResource entities.
+ */
+export interface ComponentResourceFilterFields extends BaseFilterFields {
+    title: string;
+    lessonType: string;
+    'courseComponent.sourcedId': string;
+}
+/**
+ * Filterable fields for AssessmentLineItem entities.
+ */
+export interface AssessmentLineItemFilterFields extends BaseFilterFields {
+    title: string;
+    description: string;
+    assignDate: Date;
+    dueDate: Date;
+}
+/**
+ * Filterable fields for AssessmentResult entities.
+ */
+export interface AssessmentResultFilterFields extends BaseFilterFields {
+    score: number;
+    scoreDate: Date;
+    scoreStatus: string;
+}
+/**
+ * Filterable fields for Demographics entities.
+ */
+export interface DemographicsFilterFields extends BaseFilterFields {
+    birthDate: string;
+    sex: 'male' | 'female';
+}
+/**
+ * Filterable fields for Category entities.
+ */
+export interface CategoryFilterFields extends BaseFilterFields {
+    title: string;
+}
+/**
+ * Filterable fields for ScoreScale entities.
+ */
+export interface ScoreScaleFilterFields extends BaseFilterFields {
+    title: string;
+}
+/**
+ * Filterable fields for Resource entities.
+ */
+export interface ResourceFilterFields extends BaseFilterFields {
+    title: string;
+    vendorResourceId: string;
+    vendorId: string;
+    applicationId: string;
+}
+//# sourceMappingURL=filters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../src/types/filters.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAM1E;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,QAAQ,GAAG,aAAa,CAAA;IAChC,gBAAgB,EAAE,IAAI,CAAA;CACtB;AAMD;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACzD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,yFAAyF;IACzF,IAAI,EAAE,iBAAiB,CAAA;CACvB;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,gBAAgB,CAAA;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,UAAU,GAAG,WAAW,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACd;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CAChB;AAMD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,iBAAiB,CAAA;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,IAAI,CAAA;IACf,OAAO,EAAE,IAAI,CAAA;IACb,iBAAiB,EAAE,MAAM,CAAA;CACzB;AAMD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACpE,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,eAAe,GAAG,UAAU,GAAG,YAAY,GAAG,MAAM,CAAA;IAC1D,SAAS,EAAE,IAAI,CAAA;IACf,OAAO,EAAE,IAAI,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;CAClB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,IAAI,CAAA;CACb;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,IAAI,CAAA;IACf,WAAW,EAAE,QAAQ,GAAG,cAAc,GAAG,eAAe,GAAG,kBAAkB,GAAG,WAAW,CAAA;CAC3F;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,SAAS,GAAG,WAAW,CAAA;CACnC;AAMD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACpE,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,kBAAkB,EAAE,MAAM,CAAA;CAC1B;AAMD;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACtE,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,2BAA2B,EAAE,MAAM,CAAA;CACnC;AAMD;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,gBAAgB;IACvE,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,IAAI,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,gBAAgB;IACrE,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,IAAI,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IACjE,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,KAAK,EAAE,MAAM,CAAA;CACb;AAMD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,KAAK,EAAE,MAAM,CAAA;CACb;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACrB"}