@timeback/powerpath 0.1.3 → 0.1.4

package/dist/public-types.d.ts

@@ -0,0 +1,660 @@
+/**
+ * PowerPath Base Types
+ *
+ * Common types and enums for PowerPath API responses.
+ */
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ENUMS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Test assignment status values.
+ */
+type TestAssignmentStatus =
+	| 'assigned'
+	| 'in_progress'
+	| 'completed'
+	| 'failed'
+	| 'expired'
+	| 'cancelled'
+
+/**
+ * Lesson plan operation types.
+ */
+type LessonPlanOperationType =
+	| 'set-skipped'
+	| 'add-custom-resource'
+	| 'move-item-before'
+	| 'move-item-after'
+	| 'move-item-to-start'
+	| 'move-item-to-end'
+	| 'change-item-parent'
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// PAGINATION
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Pagination metadata from PowerPath list responses.
+ */
+interface PaginationMeta {
+	/** Total items across all pages */
+	totalCount: number
+	/** Total number of pages */
+	pageCount: number
+	/** Current page number (1-indexed) */
+	pageNumber: number
+	/**
+	 * Offset for the next page of results.
+	 *
+	 * This API uses offset pagination: request `offset` is the number of items to skip.
+	 * List responses also include an `offset` field; treat it as the server-provided
+	 * next offset (and fall back to `currentOffset + limit` when implementing iterators).
+	 */
+	offset: number
+	/** Items per page (default 100, max 3000) */
+	limit: number
+}
+
+/**
+ * PowerPath Response Types
+ *
+ * Entity types returned by PowerPath API endpoints.
+ */
+
+
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// TEST ASSIGNMENTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * A single test assignment entity.
+ */
+interface TestAssignment {
+	sourcedId: string
+	studentSourcedId: string
+	studentEmail: string
+	assignedByUserSourcedId?: string
+	subject: string
+	grade: string
+	assignmentStatus: TestAssignmentStatus
+	testName?: string
+	assignedAt?: string
+	expiresAt?: string
+	completedAt?: string
+	resourceSourcedId?: string
+	componentResourceSourcedId?: string
+}
+
+/**
+ * List response for test assignments.
+ */
+interface TestAssignmentsListResponse extends PaginationMeta {
+	testAssignments: TestAssignment[]
+}
+
+/**
+ * Result from creating a test assignment.
+ */
+interface AssignmentResult {
+	assignmentId: string
+	lessonId: string
+	resourceId: string
+}
+
+/**
+ * Result from bulk operations.
+ */
+interface BulkResult {
+	success: boolean
+	results: AssignmentResult[]
+	errors: Array<{ row: number; message: string }>
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ASSESSMENTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Result from creating an external test (test-out, placement, or internal).
+ */
+interface ExternalTestCreateResponse {
+	lessonId: string
+	resourceId: string
+}
+
+/**
+ * A single attempt record.
+ */
+interface Attempt {
+	attempt?: number
+	score: number
+	scoreStatus: string
+}
+
+/**
+ * Result from creating a new attempt.
+ */
+interface CreateAttemptResponse {
+	attempt: Attempt
+}
+
+/**
+ * Result from getting attempts for a lesson.
+ */
+interface GetAttemptsResponse {
+	attempts: Attempt[]
+}
+
+/**
+ * Result from getting assessment progress.
+ * Shape varies by context; stable fields are typed.
+ */
+interface GetAssessmentProgressResponse {
+	lessonType?: string
+	[key: string]: unknown
+}
+
+/**
+ * Result from resetting an attempt.
+ */
+interface ResetAttemptResponse {
+	success: boolean
+	score: number
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// PLACEMENT
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Result from getting all placement tests.
+ */
+interface GetAllPlacementTestsResponse {
+	placementTests: unknown[]
+}
+
+/**
+ * Result from getting current placement level.
+ */
+interface GetCurrentLevelResponse {
+	gradeLevel?: unknown
+	onboarded?: boolean
+	availableTests: number
+}
+
+/**
+ * Result from getting the next placement test.
+ */
+interface GetNextPlacementTestResponse {
+	availableTests: number
+	lesson: string
+}
+
+/**
+ * Result from getting subject progress.
+ */
+interface GetSubjectProgressResponse {
+	progress: unknown[]
+}
+
+/**
+ * Result from resetting placement.
+ */
+interface ResetPlacementResponse {
+	success: boolean
+	placementResultsDeleted: number
+	onboardingReset: boolean
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// SCREENING
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Result from screening getResults.
+ * Response shape depends on MAP integration configuration.
+ */
+interface ScreeningResultsResponse {
+	[key: string]: unknown
+}
+
+/**
+ * Result from screening getSession.
+ * Response shape depends on MAP integration configuration.
+ */
+interface ScreeningSessionResponse {
+	[key: string]: unknown
+}
+
+/**
+ * Result from resetting a screening session.
+ */
+interface ScreeningResetSessionResponse {
+	success?: boolean
+	[key: string]: unknown
+}
+
+/**
+ * Result from assigning a screening test.
+ */
+interface ScreeningAssignTestResponse {
+	success?: boolean
+	[key: string]: unknown
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// LESSON PLANS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Result from creating a lesson plan.
+ */
+interface LessonPlanCreateResponse {
+	lessonPlanId: string
+}
+
+/**
+ * A lesson plan operation record.
+ */
+interface LessonPlanOperation {
+	id: string
+	type: string
+	payload?: unknown
+	reason?: string
+	createdAt: string
+	sequenceNumber: number
+	createdBy?: string
+}
+
+/**
+ * Response containing lesson plan operations.
+ */
+interface LessonPlanOperationsResponse {
+	operations: LessonPlanOperation[]
+}
+
+/**
+ * Result from a single lesson plan operation.
+ */
+interface LessonPlanOperationResult {
+	success: boolean
+	message?: string
+	operationId?: string
+}
+
+/**
+ * Result from syncing lesson plan operations.
+ */
+interface LessonPlanSyncResult {
+	success: boolean
+	message?: string
+	operationCount: number
+	operationResults: Array<{ success: boolean; errors?: Array<{ message: string }> }>
+}
+
+/**
+ * Result from syncing a course.
+ */
+interface LessonPlanCourseSyncResult {
+	lessonPlansAffected: string[]
+}
+
+/**
+ * Response containing a lesson plan.
+ */
+interface LessonPlanResponse {
+	lessonPlan: Record<string, unknown>
+}
+
+/**
+ * Response containing course progress.
+ */
+interface CourseProgressResponse {
+	lineItems: Record<string, unknown>[]
+}
+
+/**
+ * Result from updating student item response.
+ */
+interface UpdateStudentItemResponseResult {
+	success?: boolean
+	[key: string]: unknown
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// SYLLABUS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Response containing syllabus data.
+ */
+interface SyllabusResponse {
+	syllabus?: unknown
+}
+
+type input<T> = T extends {
+    _zod: {
+        input: any;
+    };
+} ? T["_zod"]["input"] : unknown;
+
+/**
+ * PowerPath Schemas
+ *
+ * Zod schemas for the PowerPath adaptive learning API.
+ */
+
+
+
+declare const ExternalTestOut = ExternalTestBase.extend({
+	lessonType: z.literal('test-out'),
+	xp: z.number(),
+})
+
+declare const ExternalPlacement = ExternalTestBase.extend({
+	lessonType: z.literal('placement'),
+	courseIdOnFail: NonEmptyString.optional(),
+	xp: z.number().optional(),
+})
+
+declare const PowerPathCreateExternalPlacementTestInput = ExternalPlacement
+
+declare const PowerPathCreateExternalTestOutInput = ExternalTestOut
+
+declare const PowerPathCreateInternalTestInput = z.union([
+	InternalTestBase.extend({
+		testType: z.literal('qti'),
+		qti: z.object({
+			url: z.url(),
+			title: NonEmptyString.optional(),
+			metadata: z.record(z.string(), z.unknown()).optional(),
+		}),
+	}),
+	InternalTestBase.extend({
+		testType: z.literal('assessment-bank'),
+		assessmentBank: z.object({
+			resources: z.array(
+				z.object({
+					url: z.url(),
+					title: NonEmptyString.optional(),
+					metadata: z.record(z.string(), z.unknown()).optional(),
+				}),
+			),
+		}),
+	}),
+])
+
+declare const PowerPathCreateNewAttemptInput = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathFinalStudentAssessmentResponseInput = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathLessonPlansCreateInput = z.object({
+	courseId: NonEmptyString,
+	userId: NonEmptyString,
+	classId: NonEmptyString.optional(),
+})
+
+declare const PowerPathLessonPlanOperationInput = z.union([
+	z.object({
+		type: z.literal('set-skipped'),
+		payload: z.object({
+			target: LessonPlanTarget,
+			value: z.boolean(),
+		}),
+	}),
+	z.object({
+		type: z.literal('add-custom-resource'),
+		payload: z.object({
+			resource_id: NonEmptyString,
+			parent_component_id: NonEmptyString,
+			skipped: z.boolean().optional(),
+		}),
+	}),
+	z.object({
+		type: z.literal('move-item-before'),
+		payload: z.object({
+			target: LessonPlanTarget,
+			reference_id: NonEmptyString,
+		}),
+	}),
+	z.object({
+		type: z.literal('move-item-after'),
+		payload: z.object({
+			target: LessonPlanTarget,
+			reference_id: NonEmptyString,
+		}),
+	}),
+	z.object({
+		type: z.literal('move-item-to-start'),
+		payload: z.object({
+			target: LessonPlanTarget,
+		}),
+	}),
+	z.object({
+		type: z.literal('move-item-to-end'),
+		payload: z.object({
+			target: LessonPlanTarget,
+		}),
+	}),
+	z.object({
+		type: z.literal('change-item-parent'),
+		payload: z.object({
+			target: LessonPlanTarget,
+			new_parent_id: NonEmptyString,
+			position: z.enum(['start', 'end']).optional(),
+		}),
+	}),
+])
+
+declare const PowerPathLessonPlanOperationsInput = z.object({
+	operation: z.array(PowerPathLessonPlanOperationInput),
+	reason: NonEmptyString.optional(),
+})
+
+declare const PowerPathLessonPlanUpdateStudentItemResponseInput = z.object({
+	studentId: NonEmptyString,
+	componentResourceId: NonEmptyString,
+	result: z.object({
+		status: z.enum(['active', 'tobedeleted']),
+		metadata: z.record(z.string(), z.unknown()).optional(),
+		score: z.number().optional(),
+		textScore: NonEmptyString.optional(),
+		scoreDate: NonEmptyString,
+		scorePercentile: z.number().optional(),
+		scoreStatus: ScoreStatus,
+		comment: NonEmptyString.optional(),
+		learningObjectiveSet: z
+			.array(
+				z.object({
+					source: NonEmptyString,
+					learningObjectiveResults: z.array(
+						z.object({
+							learningObjectiveId: NonEmptyString,
+							score: z.number().optional(),
+							textScore: NonEmptyString.optional(),
+						}),
+					),
+				}),
+			)
+			.optional(),
+		inProgress: NonEmptyString.optional(),
+		incomplete: NonEmptyString.optional(),
+		late: NonEmptyString.optional(),
+		missing: NonEmptyString.optional(),
+	}),
+})
+
+declare const PowerPathMakeExternalTestAssignmentInput = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+	applicationName: NonEmptyString.optional(),
+	testId: NonEmptyString.optional(),
+	skipCourseEnrollment: z.boolean().optional(),
+})
+
+declare const PowerPathPlacementResetUserPlacementInput = z.object({
+	student: NonEmptyString,
+	subject: TimebackSubject,
+})
+
+declare const PowerPathResetAttemptInput = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathScreeningResetSessionInput = z.object({
+	userId: NonEmptyString,
+})
+
+declare const PowerPathScreeningAssignTestInput = z.object({
+	userId: NonEmptyString,
+	subject: z.enum(['Math', 'Reading', 'Language', 'Science']),
+})
+
+declare const PowerPathTestAssignmentsCreateInput = z.object({
+	student: NonEmptyString,
+	subject: TimebackSubject,
+	grade: TimebackGrade,
+	testName: NonEmptyString.optional(),
+})
+
+declare const PowerPathTestAssignmentsUpdateInput = z.object({
+	testName: NonEmptyString,
+})
+
+declare const PowerPathTestAssignmentsBulkInput = z.object({
+	items: z.array(PowerPathTestAssignmentItemInput),
+})
+
+declare const PowerPathTestAssignmentsImportInput = z.object({
+	spreadsheetUrl: z.url(),
+	sheet: NonEmptyString,
+})
+
+declare const PowerPathTestAssignmentsListParams = z.object({
+	student: NonEmptyString,
+	status: z
+		.enum(['assigned', 'in_progress', 'completed', 'failed', 'expired', 'cancelled'])
+		.optional(),
+	subject: NonEmptyString.optional(),
+	grade: TimebackGrade.optional(),
+	limit: z.number().int().positive().max(3000).optional(),
+	offset: z.number().int().nonnegative().optional(),
+})
+
+declare const PowerPathTestAssignmentsAdminParams = z.object({
+	student: NonEmptyString.optional(),
+	status: z
+		.enum(['assigned', 'in_progress', 'completed', 'failed', 'expired', 'cancelled'])
+		.optional(),
+	subject: NonEmptyString.optional(),
+	grade: TimebackGrade.optional(),
+	limit: z.number().int().positive().max(3000).optional(),
+	offset: z.number().int().nonnegative().optional(),
+})
+
+declare const PowerPathUpdateStudentQuestionResponseInput = z.object({
+	student: NonEmptyString,
+	question: NonEmptyString,
+	response: z.union([NonEmptyString, z.array(NonEmptyString)]).optional(),
+	responses: z.record(z.string(), z.union([NonEmptyString, z.array(NonEmptyString)])).optional(),
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathGetAssessmentProgressParams = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+	attempt: z.number().int().positive().optional(),
+})
+
+declare const PowerPathGetNextQuestionParams = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathGetAttemptsParams = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+})
+
+declare const PowerPathTestOutParams = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString.optional(),
+	finalized: z.boolean().optional(),
+	toolProvider: NonEmptyString.optional(),
+	attempt: z.number().int().positive().optional(),
+})
+
+declare const PowerPathImportExternalTestAssignmentResultsParams = z.object({
+	student: NonEmptyString,
+	lesson: NonEmptyString,
+	applicationName: NonEmptyString.optional(),
+})
+
+declare const PowerPathPlacementQueryParams = z.object({
+	student: NonEmptyString,
+	subject: TimebackSubject,
+})
+
+declare const PowerPathSyllabusQueryParams = z.object({
+	status: z.enum(['active', 'tobedeleted']).optional(),
+})
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// TYPE EXPORTS (REQUEST INPUTS)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+// Shorter type aliases (like OneRoster pattern: schema = OneRosterFoo, type = Foo)
+type CreateExternalPlacementTestInput = input<
+	typeof PowerPathCreateExternalPlacementTestInput
+>
+type CreateExternalTestOutInput = input<typeof PowerPathCreateExternalTestOutInput>
+type CreateInternalTestInput = input<typeof PowerPathCreateInternalTestInput>
+type CreateNewAttemptInput = input<typeof PowerPathCreateNewAttemptInput>
+type FinalStudentAssessmentResponseInput = input<
+	typeof PowerPathFinalStudentAssessmentResponseInput
+>
+type LessonPlansCreateInput = input<typeof PowerPathLessonPlansCreateInput>
+type LessonPlanOperationInput = input<typeof PowerPathLessonPlanOperationInput>
+type LessonPlanOperationsInput = input<typeof PowerPathLessonPlanOperationsInput>
+type LessonPlanUpdateStudentItemResponseInput = input<
+	typeof PowerPathLessonPlanUpdateStudentItemResponseInput
+>
+type MakeExternalTestAssignmentInput = input<
+	typeof PowerPathMakeExternalTestAssignmentInput
+>
+type PlacementResetUserPlacementInput = input<
+	typeof PowerPathPlacementResetUserPlacementInput
+>
+type ResetAttemptInput = input<typeof PowerPathResetAttemptInput>
+type ScreeningResetSessionInput = input<typeof PowerPathScreeningResetSessionInput>
+type ScreeningAssignTestInput = input<typeof PowerPathScreeningAssignTestInput>
+type TestAssignmentsCreateInput = input<typeof PowerPathTestAssignmentsCreateInput>
+type TestAssignmentsUpdateInput = input<typeof PowerPathTestAssignmentsUpdateInput>
+type TestAssignmentsBulkInput = input<typeof PowerPathTestAssignmentsBulkInput>
+type TestAssignmentsImportInput = input<typeof PowerPathTestAssignmentsImportInput>
+type TestAssignmentsListParams = input<typeof PowerPathTestAssignmentsListParams>
+type TestAssignmentsAdminParams = input<typeof PowerPathTestAssignmentsAdminParams>
+type UpdateStudentQuestionResponseInput = input<
+	typeof PowerPathUpdateStudentQuestionResponseInput
+>
+type GetAssessmentProgressParams = input<typeof PowerPathGetAssessmentProgressParams>
+type GetNextQuestionParams = input<typeof PowerPathGetNextQuestionParams>
+type GetAttemptsParams = input<typeof PowerPathGetAttemptsParams>
+type TestOutParams = input<typeof PowerPathTestOutParams>
+type ImportExternalTestAssignmentResultsParams = input<
+	typeof PowerPathImportExternalTestAssignmentResultsParams
+>
+type PlacementQueryParams = input<typeof PowerPathPlacementQueryParams>
+type SyllabusQueryParams = input<typeof PowerPathSyllabusQueryParams>
+
+export type { AssignmentResult, Attempt, BulkResult, CourseProgressResponse, CreateAttemptResponse, CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, ExternalTestCreateResponse, FinalStudentAssessmentResponseInput, GetAllPlacementTestsResponse, GetAssessmentProgressParams, GetAssessmentProgressResponse, GetAttemptsParams, GetAttemptsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetNextQuestionParams, GetSubjectProgressResponse, ImportExternalTestAssignmentResultsParams, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationInput, LessonPlanOperationResult, LessonPlanOperationType, LessonPlanOperationsInput, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, LessonPlanUpdateStudentItemResponseInput, LessonPlansCreateInput, MakeExternalTestAssignmentInput, PaginationMeta, PlacementQueryParams, PlacementResetUserPlacementInput, ResetAttemptInput, ResetAttemptResponse, ResetPlacementResponse, ScreeningAssignTestInput, ScreeningAssignTestResponse, ScreeningResetSessionInput, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, SyllabusQueryParams, SyllabusResponse, TestAssignment, TestAssignmentStatus, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsListResponse, TestAssignmentsUpdateInput, TestOutParams, UpdateStudentItemResponseResult, UpdateStudentQuestionResponseInput };

package/dist/public-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-types.d.ts","sourceRoot":"","sources":["../src/public-types.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AAEnD,YAAY,EACX,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,mCAAmC,EACnC,2BAA2B,EAC3B,iBAAiB,EACjB,qBAAqB,EACrB,yCAAyC,EACzC,wBAAwB,EACxB,yBAAyB,EACzB,sBAAsB,EACtB,wCAAwC,EACxC,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EAChC,iBAAiB,EACjB,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EACb,kCAAkC,GAClC,MAAM,qBAAqB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@timeback/powerpath",
-	"version": "0.1.3",
+	"version": "0.1.4",
 	"description": "PowerPath client SDK for Timeback",
 	"type": "module",
 	"exports": {
@@ -13,8 +13,8 @@
 			"import": "./dist/errors.js"
 		},
 		"./types": {
-			"types": "./dist/types.d.ts",
-			"import": "./dist/types.js"
+			"types": "./dist/public-types.d.ts",
+			"import": "./dist/public-types.js"
 		}
 	},
 	"main": "dist/index.js",