@timeback/edubridge 0.1.0

package/dist/lib/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Internal Library Exports
+ *
+ * @internal
+ */
+export { resolveToProvider } from './resolve';
+export { Transport } from './transport';
+export type { ResolvedConfig } from '@timeback/internal-client-infra';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA"}

package/dist/lib/resolve.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Provider Resolution
+ *
+ * Edubridge-specific wrapper around the generic provider resolver.
+ *
+ * @internal
+ */
+import type { ProviderRegistry } from '@timeback/internal-client-infra';
+import type { EdubridgeClientConfig, EdubridgeResolvedProvider } from '../types';
+/**
+ * Resolve Edubridge client config to a TimebackProvider.
+ *
+ * @param config - Client configuration
+ * @param registry - Provider registry for platform/env resolution
+ * @returns Resolved provider or transport
+ * @throws {Error} If configuration is invalid or incomplete
+ *
+ * @internal
+ */
+export declare function resolveToProvider(config: EdubridgeClientConfig, registry?: ProviderRegistry): EdubridgeResolvedProvider;
+//# sourceMappingURL=resolve.d.ts.map

package/dist/lib/resolve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../src/lib/resolve.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AASH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAA;AAEhF;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAChC,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,GAAE,gBAA4C,GACpD,yBAAyB,CAM3B"}

package/dist/lib/transport.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Transport Layer
+ *
+ * HTTP transport for Edubridge API communication.
+ */
+import { BaseTransport } from '@timeback/internal-client-infra';
+import type { EdubridgePaths, PaginatedResponse, RequestOptions } from '@timeback/internal-client-infra';
+import type { EdubridgeTransportConfig } from '../types';
+/**
+ * HTTP transport layer for Edubridge API communication.
+ *
+ * Uses body-based pagination (totalCount, pageNumber, pageCount in response body).
+ */
+export declare class Transport extends BaseTransport {
+    /** API path profiles for Edubridge operations */
+    readonly paths: EdubridgePaths;
+    constructor(config: EdubridgeTransportConfig);
+    /**
+     * Make a paginated request using body-based pagination.
+     *
+     * Edubridge APIs return pagination metadata in the response body:
+     * - `totalCount`: Total items across all pages
+     * - `pageCount`: Total number of pages
+     * - `pageNumber`: Current page (1-indexed)
+     *
+     * The returned `data` is the full response body. Use Paginator's `unwrapKey`
+     * to extract the actual items (e.g., "users", "enrollments").
+     *
+     * @template T - Expected item type in the response
+     * @param path - API endpoint path
+     * @param options - Request options
+     * @returns Normalized paginated response with body as data
+     */
+    requestPaginated<T>(path: string, options?: RequestOptions): Promise<PaginatedResponse<T>>;
+    /**
+     * Extract error message from Edubridge API error response.
+     *
+     * Edubridge returns errors in array format:
+     * - `errors[].message`: High-level error message
+     * - `errors[].detail`: More specific error detail
+     * - `errors[].meta.issues[]`: Field-level validation errors
+     *
+     * @param body - The error response body
+     * @param fallback - Fallback message if extraction fails
+     * @returns Human-readable error message with field details
+     */
+    protected extractErrorMessage(body: unknown, fallback: string): string;
+}
+//# sourceMappingURL=transport.d.ts.map

package/dist/lib/transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/lib/transport.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAA0B,MAAM,iCAAiC,CAAA;AAIvF,OAAO,KAAK,EAEX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAqBxD;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,aAAa;IAC3C,iDAAiD;IACjD,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;IAE9B,YAAY,MAAM,EAAE,wBAAwB,EAG3C;IAED;;;;;;;;;;;;;;;OAeG;IACG,gBAAgB,CAAC,CAAC,EACvB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAI/B;IAED;;;;;;;;;;;OAWG;IACH,UAAmB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAmC9E;CACD"}

package/dist/resources/analytics.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Analytics Resource
+ *
+ * Student activity data and metrics.
+ */
+import type { ActivityParams, DailyActivityMap, EdubridgeTransportLike, EnrollmentFacts, EnrollmentFactsParams, HighestGradeMastered, WeeklyFacts, WeeklyFactsParams } from '../types';
+/**
+ * Analytics resource for retrieving student activity data.
+ *
+ * Provides access to activity metrics, weekly facts, and grade mastery data.
+ */
+export declare class AnalyticsResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * Get activity data for a date range.
+     *
+     * Returns metrics grouped by date, then by subject.
+     * Accepts dates in YYYY-MM-DD or full ISO 8601 format.
+     *
+     * @param params - Query parameters including email or studentId, startDate, endDate
+     * @returns Activity data keyed by date, then subject
+     */
+    getActivity(params: ActivityParams): Promise<DailyActivityMap>;
+    /**
+     * Get weekly facts for a student.
+     *
+     * Returns individual facts grouped by date for a specific week.
+     * Accepts weekDate in YYYY-MM-DD or full ISO 8601 format.
+     *
+     * @param params - Query parameters including email or studentId and weekDate
+     * @returns Weekly facts data
+     */
+    getWeeklyFacts(params: WeeklyFactsParams): Promise<WeeklyFacts>;
+    /**
+     * Get aggregated facts for an enrollment.
+     *
+     * Returns aggregated metrics for all activity within an enrollment.
+     * Accepts dates in YYYY-MM-DD or full ISO 8601 format.
+     *
+     * @param params - Query parameters including enrollmentId and optional date filters
+     * @returns Enrollment facts
+     */
+    getEnrollmentFacts(params: EnrollmentFactsParams): Promise<EnrollmentFacts>;
+    /**
+     * Get the highest grade a student has mastered for a subject.
+     *
+     * Returns grade data from multiple sources (Edulastic, placement tests, test-out).
+     *
+     * @param studentId - Student ID
+     * @param subject - Subject name
+     * @returns Highest grade mastered data
+     */
+    getHighestGradeMastered(studentId: string, subject: string): Promise<HighestGradeMastered>;
+}
+//# sourceMappingURL=analytics.d.ts.map

package/dist/resources/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/resources/analytics.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EACX,cAAc,EAEd,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EAErB,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EAEjB,MAAM,UAAU,CAAA;AAEjB;;;;GAIG;AACH,qBAAa,iBAAiB;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;;;;;OAQG;IACG,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAcnE;IAED;;;;;;;;OAQG;IACG,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAapE;IAED;;;;;;;;OAQG;IACG,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAYhF;IAED;;;;;;;;OAQG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAIzF;CACD"}

package/dist/resources/applications.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Applications Resource
+ *
+ * Manage and retrieve applications available in the system.
+ */
+import type { Application, ApplicationMetrics, EdubridgeTransportLike } from '../types';
+/**
+ * Applications resource for managing learning platforms.
+ *
+ * Applications represent different learning platforms or educational
+ * software that can be integrated with Timeback.
+ */
+export declare class ApplicationsResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * List all applications.
+     *
+     * @returns List of applications
+     */
+    list(): Promise<Application[]>;
+    /**
+     * Get metrics for an application.
+     *
+     * @param applicationSourcedId - Application ID
+     * @returns Application metrics
+     */
+    getMetrics(applicationSourcedId: string): Promise<ApplicationMetrics>;
+}
+//# sourceMappingURL=applications.d.ts.map

package/dist/resources/applications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applications.d.ts","sourceRoot":"","sources":["../../src/resources/applications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEvF;;;;;GAKG;AACH,qBAAa,oBAAoB;IACpB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAKnC;IAED;;;;;OAKG;IACG,UAAU,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAK1E;CACD"}

package/dist/resources/enrollments.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Enrollments Resource
+ *
+ * Simplified, course-centric enrollment management.
+ */
+import type { DefaultClass, EdubridgeTransportLike, Enrollment, EnrollOptions, ListEnrollmentsParams, ResetGoalsResult } from '../types';
+/**
+ * Enrollments resource for course-centric enrollment management.
+ *
+ * Provides simplified methods to enroll/unenroll users in courses
+ * without needing to understand the underlying OneRoster academic hierarchy.
+ */
+export declare class EnrollmentsResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * List enrollments with filtering.
+     *
+     * @param params - Query parameters including userId filter
+     * @returns List of course enrollments
+     */
+    list(params: ListEnrollmentsParams): Promise<Enrollment[]>;
+    /**
+     * Enroll a user in a course.
+     *
+     * Automatically handles creating the appropriate class and academic session
+     * records required by OneRoster.
+     *
+     * @param userId - User ID to enroll
+     * @param courseId - Course ID to enroll in
+     * @param schoolId - Optional school ID (uses user's primary org if not specified)
+     * @param options - Enrollment options (role, metadata, etc.)
+     * @returns Created enrollment
+     */
+    enroll(userId: string, courseId: string, schoolId?: string, options?: EnrollOptions): Promise<Enrollment>;
+    /**
+     * Unenroll a user from a course.
+     *
+     * Marks the enrollment as 'tobedeleted'.
+     *
+     * @param userId - User ID to unenroll
+     * @param courseId - Course ID to unenroll from
+     * @param schoolId - Optional school ID
+     */
+    unenroll(userId: string, courseId: string, schoolId?: string): Promise<void>;
+    /**
+     * Reset enrollment goals for all users in a course.
+     *
+     * @param courseId - Course ID to reset goals for
+     * @returns Result with count of updated enrollments
+     */
+    resetGoals(courseId: string): Promise<ResetGoalsResult>;
+    /**
+     * Reset a user's progress in a course.
+     *
+     * Marks all assessment results for the user/course as 'tobedeleted'.
+     *
+     * @param userId - User ID
+     * @param courseId - Course ID
+     */
+    resetProgress(userId: string, courseId: string): Promise<void>;
+    /**
+     * Get the default class for a course.
+     *
+     * @param courseId - Course ID
+     * @param schoolId - Optional school ID
+     * @returns Default class and term information
+     */
+    getDefaultClass(courseId: string, schoolId?: string): Promise<DefaultClass>;
+}
+//# sourceMappingURL=enrollments.d.ts.map

package/dist/resources/enrollments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrollments.d.ts","sourceRoot":"","sources":["../../src/resources/enrollments.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAEX,YAAY,EACZ,sBAAsB,EACtB,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,MAAM,UAAU,CAAA;AAEjB;;;;;GAKG;AACH,qBAAa,mBAAmB;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;;OAKG;IACG,IAAI,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAK/D;IAED;;;;;;;;;;;OAWG;IACG,MAAM,CACX,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,aAAkB,GACzB,OAAO,CAAC,UAAU,CAAC,CASrB;IAED;;;;;;;;OAQG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKjF;IAED;;;;;OAKG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAM5D;IAED;;;;;;;OAOG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKnE;IAED;;;;;;OAMG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAMhF;CACD"}

package/dist/resources/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Edubridge Resources
+ */
+export { AnalyticsResource } from './analytics';
+export { ApplicationsResource } from './applications';
+export { EnrollmentsResource } from './enrollments';
+export { LearningReportsResource } from './learning-reports';
+export { SubjectTrackResource } from './subject-track';
+export { UsersResource } from './users';
+//# sourceMappingURL=index.d.ts.map

package/dist/resources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}

package/dist/resources/learning-reports.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Learning Reports Resource
+ *
+ * Student learning reports and time tracking.
+ */
+import type { EdubridgeTransportLike, MapProfile, TimeSaved } from '../types';
+/**
+ * Learning Reports resource for student progress data.
+ *
+ * Provides access to MAP profiles and time saved metrics.
+ */
+export declare class LearningReportsResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * Get MAP profile for a user.
+     *
+     * @param userId - User ID
+     * @returns MAP profile data
+     */
+    getMapProfile(userId: string): Promise<MapProfile>;
+    /**
+     * Get time saved metrics for a user.
+     *
+     * @param userId - User ID
+     * @returns Time saved data
+     */
+    getTimeSaved(userId: string): Promise<TimeSaved>;
+}
+//# sourceMappingURL=learning-reports.d.ts.map

package/dist/resources/learning-reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"learning-reports.d.ts","sourceRoot":"","sources":["../../src/resources/learning-reports.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAE7E;;;;GAIG;AACH,qBAAa,uBAAuB;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAKvD;IAED;;;;;OAKG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAKrD;CACD"}

package/dist/resources/subject-track.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Subject Track Resource
+ *
+ * Manage subject track mappings.
+ */
+import type { EdubridgeTransportLike, SubjectTrack, SubjectTrackGroup, SubjectTrackInput } from '../types';
+/**
+ * Subject Track resource for managing subject-to-course mappings.
+ *
+ * Subject tracks determine the target course for each subject and grade level.
+ * For example, for subject 'Math' grade level '9', the target course can be
+ * 'Math Academy 9th Grade'.
+ */
+export declare class SubjectTrackResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * List all subject tracks.
+     *
+     * @returns List of subject tracks
+     */
+    list(): Promise<SubjectTrack[]>;
+    /**
+     * Create or update a subject track.
+     *
+     * This is an upsert operation - if the subject track with the given id
+     * exists it will be updated, otherwise it will be created.
+     *
+     * @param data - Subject track data including id
+     * @returns The created or updated subject track
+     */
+    upsert(data: SubjectTrackInput & {
+        id: string;
+    }): Promise<SubjectTrack>;
+    /**
+     * Delete a subject track.
+     *
+     * @param id - Subject track ID
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * List all subject track groups.
+     *
+     * @returns List of subject track groups
+     */
+    listGroups(): Promise<SubjectTrackGroup[]>;
+}
+//# sourceMappingURL=subject-track.d.ts.map

package/dist/resources/subject-track.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subject-track.d.ts","sourceRoot":"","sources":["../../src/resources/subject-track.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACX,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,EAEjB,iBAAiB,EAGjB,MAAM,UAAU,CAAA;AAEjB;;;;;;GAMG;AACH,qBAAa,oBAAoB;IACpB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAKpC;IAED;;;;;;;;OAQG;IACG,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAM5E;IAED;;;;OAIG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKtC;IAED;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAK/C;CACD"}

package/dist/resources/users.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Users Resource
+ *
+ * Enhanced user management beyond standard OneRoster.
+ */
+import type { EdubridgeTransportLike, ListUsersParams, Role, User } from '../types';
+/**
+ * Users resource for querying users with enhanced filtering.
+ *
+ * Provides role-based filtering and search capabilities beyond
+ * the standard OneRoster API.
+ */
+export declare class UsersResource {
+    private readonly transport;
+    constructor(transport: EdubridgeTransportLike);
+    /**
+     * List users with filtering.
+     *
+     * Returns users who have exclusively the specified role(s) and no other roles.
+     *
+     * @param params - Query parameters including required roles filter
+     * @returns List of matching users
+     */
+    list(params: ListUsersParams): Promise<User[]>;
+    /**
+     * List all students.
+     *
+     * Convenience method for listing users with student role.
+     *
+     * @param params - Optional query parameters
+     * @returns List of students
+     */
+    listStudents(params?: Omit<ListUsersParams, 'roles'>): Promise<User[]>;
+    /**
+     * List all teachers.
+     *
+     * Convenience method for listing users with teacher role.
+     *
+     * @param params - Optional query parameters
+     * @returns List of teachers
+     */
+    listTeachers(params?: Omit<ListUsersParams, 'roles'>): Promise<User[]>;
+    /**
+     * Search users by role.
+     *
+     * @param roles - Roles to filter by
+     * @param search - Search term
+     * @param limit - Maximum results
+     * @returns List of matching users
+     */
+    search(roles: Role[], search: string, limit?: number): Promise<User[]>;
+}
+//# sourceMappingURL=users.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,sBAAsB,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAEnF;;;;;GAKG;AACH,qBAAa,aAAa;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE;;;;;;;OAOG;IACG,IAAI,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CA2CnD;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,GAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEzE;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,GAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEzE;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAElE;CACD"}

package/dist/types/analytics.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Analytics Types
+ *
+ * Types for analytics and reporting endpoints.
+ */
+/**
+ * Activity metrics from the API.
+ */
+export interface ActivityMetricsData {
+    xpEarned: number;
+    totalQuestions: number;
+    correctQuestions: number;
+    masteredUnits: number;
+}
+/**
+ * Time spent metrics from the API.
+ */
+export interface TimeSpentMetricsData {
+    activeSeconds: number;
+    inactiveSeconds: number;
+    wasteSeconds: number;
+}
+/**
+ * Metrics for a specific subject on a given day.
+ */
+export interface SubjectMetrics {
+    activityMetrics: ActivityMetricsData;
+    timeSpentMetrics: TimeSpentMetricsData;
+    apps: string[];
+}
+/**
+ * Activity data grouped by date, then by subject.
+ *
+ * @example
+ * ```typescript
+ * const activity: DailyActivityMap = {
+ *   "2025-12-17": {
+ *     "FastMath": {
+ *       activityMetrics: { xpEarned: 3.4, totalQuestions: 114, ... },
+ *       timeSpentMetrics: { activeSeconds: 0, ... },
+ *       apps: ["Math Raiders"]
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export type DailyActivityMap = Record<string, Record<string, SubjectMetrics>>;
+/**
+ * A single fact/event record from the weekly facts endpoint.
+ */
+export interface WeeklyFactRecord {
+    id: number;
+    email: string;
+    date: string;
+    datetime: string;
+    username?: string;
+    userGrade?: string;
+    userFamilyName?: string;
+    userGivenName?: string;
+    userId?: string;
+    subject?: string;
+    app?: string;
+    courseId?: string;
+    courseName?: string;
+    campusId?: string;
+    campusName?: string;
+    enrollmentId?: string;
+    activityId?: string;
+    activityName?: string;
+    totalQuestions?: number;
+    correctQuestions?: number;
+    xpEarned?: number;
+    masteredUnits?: number;
+    activeSeconds?: string;
+    inactiveSeconds?: string;
+    wasteSeconds?: string;
+    source: string;
+    alphaLevel?: string;
+    generatedAt?: string;
+    sendTime?: string;
+    sensor?: string;
+    eventType?: string;
+    year: number;
+    month: number;
+    day: number;
+    dayOfWeek: number;
+}
+/**
+ * Weekly facts is an array of individual fact records.
+ */
+export type WeeklyFacts = WeeklyFactRecord[];
+/**
+ * Enrollment facts grouped by date, then by subject.
+ *
+ * Same structure as DailyActivityMap - the enrollment endpoint returns
+ * activity data filtered to a specific enrollment.
+ */
+export type EnrollmentFacts = DailyActivityMap;
+/**
+ * Grade mastery data from various sources.
+ */
+export interface GradeMasteryData {
+    ritGrade: number | null;
+    edulasticGrade: string | null;
+    placementGrade: string | null;
+    testOutGrade: string | null;
+    highestGradeOverall: string | null;
+}
+/**
+ * Highest grade mastered for a subject.
+ */
+export interface HighestGradeMastered {
+    studentId: string;
+    subject: string;
+    grades: GradeMasteryData;
+}
+/**
+ * Response from the activity endpoint.
+ */
+export interface ActivityResponse {
+    message: string;
+    startDate: string;
+    endDate: string;
+    facts: DailyActivityMap;
+    factsByApp?: Record<string, Record<string, Record<string, SubjectMetrics>>>;
+}
+/**
+ * Response from the weekly facts endpoint.
+ */
+export interface WeeklyFactsResponse {
+    message: string;
+    startDate: string;
+    endDate: string;
+    facts: WeeklyFacts;
+}
+/**
+ * Response from the enrollment facts endpoint.
+ */
+export interface EnrollmentFactsResponse {
+    message: string;
+    enrollmentId: string;
+    startDate?: string;
+    endDate?: string;
+    facts: EnrollmentFacts;
+    factsByApp?: Record<string, Record<string, Record<string, SubjectMetrics>>>;
+}
+/**
+ * Parameters for activity query.
+ *
+ * Must provide either `email` or `studentId` to identify the user.
+ */
+export interface ActivityParams {
+    /** User email address */
+    email?: string;
+    /** Student sourcedId */
+    studentId?: string;
+    /** Start date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ) */
+    startDate: string;
+    /** End date (ISO format: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ) */
+    endDate: string;
+    /** IANA timezone for date calculations (e.g., America/New_York) */
+    timezone?: string;
+}
+/**
+ * Parameters for weekly facts query.
+ *
+ * Must provide either `email` or `studentId` to identify the user.
+ */
+export interface WeeklyFactsParams {
+    /** User email address */
+    email?: string;
+    /** Student sourcedId */
+    studentId?: string;
+    /** Week date (ISO format) - required, determines which week to query */
+    weekDate: string;
+    /** IANA timezone for date calculations (e.g., America/New_York) */
+    timezone?: string;
+}
+/**
+ * Parameters for enrollment facts query.
+ */
+export interface EnrollmentFactsParams {
+    /** Enrollment ID */
+    enrollmentId: string;
+    /** Start date filter (ISO format) */
+    startDate?: string;
+    /** End date filter (ISO format) */
+    endDate?: string;
+    /** Timezone for date calculations */
+    timezone?: string;
+}
+/**
+ * Aggregated metrics across all dates and subjects.
+ *
+ * Use `aggregateActivityMetrics()` to compute this from a DailyActivityMap.
+ */
+export interface AggregatedMetrics {
+    totalXp: number;
+    totalQuestions: number;
+    correctQuestions: number;
+    masteredUnits: number;
+    activeSeconds: number;
+    inactiveSeconds: number;
+    wasteSeconds: number;
+    dayCount: number;
+    subjectCount: number;
+}
+//# sourceMappingURL=analytics.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/types/analytics.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,eAAe,EAAE,mBAAmB,CAAA;IACpC,gBAAgB,EAAE,oBAAoB,CAAA;IACtC,IAAI,EAAE,MAAM,EAAE,CAAA;CACd;AAMD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAA;AAM7E;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,gBAAgB,EAAE,CAAA;AAM5C;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAA;AAM9C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,gBAAgB,CAAA;CACxB;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAA;CAC3E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,WAAW,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,eAAe,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAA;CAC3E;AAMD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAA;IACf,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAA;IAChB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB;AAMD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACpB"}

package/dist/types/applications.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Application Types
+ *
+ * Types for application management.
+ */
+/**
+ * An application/learning platform.
+ */
+export interface Application {
+    sourcedId: string;
+    name: string;
+    description?: string | null;
+    domain: string[];
+    metadata?: Record<string, unknown> | null;
+}
+/**
+ * Metrics for an application.
+ */
+export interface ApplicationMetrics {
+    applicationSourcedId: string;
+    totalUsers?: number;
+    activeUsers?: number;
+    totalSessions?: number;
+    avgSessionDuration?: number;
+    metadata?: Record<string, unknown>;
+}
+//# sourceMappingURL=applications.d.ts.map