@timeback/powerpath 0.1.6-beta.20260224173034 → 0.1.6-beta.20260226012358
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +182 -34
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +17 -12
- package/dist/public-types.d.ts +180 -32
- package/dist/resources/assessment.d.ts +3 -3
- package/dist/resources/assessment.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -26,7 +26,39 @@ type TestAssignmentStatus =
|
|
|
26
26
|
/**
|
|
27
27
|
* Lesson types for PowerPath assessments.
|
|
28
28
|
*/
|
|
29
|
-
type PowerPathLessonType =
|
|
29
|
+
type PowerPathLessonType =
|
|
30
|
+
| 'powerpath-100'
|
|
31
|
+
| 'quiz'
|
|
32
|
+
| 'test-out'
|
|
33
|
+
| 'placement'
|
|
34
|
+
| 'unit-test'
|
|
35
|
+
| 'alpha-read-article'
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Lesson types that behave like quizzes (static tests with finalization).
|
|
39
|
+
*
|
|
40
|
+
* These types can be finalized via `finalStudentAssessmentResponse`,
|
|
41
|
+
* return score 0 while not finalized, and support both internal and external tests.
|
|
42
|
+
*/
|
|
43
|
+
type QuizLikeLessonType = 'quiz' | 'test-out' | 'placement' | 'unit-test'
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Lesson types that support external test assignment via third-party tools.
|
|
47
|
+
*
|
|
48
|
+
* These types can use `makeExternalTestAssignment` and
|
|
49
|
+
* `importExternalTestAssignmentResults`.
|
|
50
|
+
*/
|
|
51
|
+
type ExternalTestCapableLessonType = 'test-out' | 'placement' | 'unit-test'
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Score status values for assessment attempts.
|
|
55
|
+
*/
|
|
56
|
+
type ScoreStatus =
|
|
57
|
+
| 'exempt'
|
|
58
|
+
| 'fully graded'
|
|
59
|
+
| 'not submitted'
|
|
60
|
+
| 'partially graded'
|
|
61
|
+
| 'submitted'
|
|
30
62
|
|
|
31
63
|
/**
|
|
32
64
|
* Question difficulty levels.
|
|
@@ -78,16 +110,16 @@ interface TestAssignment {
|
|
|
78
110
|
sourcedId: string
|
|
79
111
|
studentSourcedId: string
|
|
80
112
|
studentEmail: string
|
|
81
|
-
assignedByUserSourcedId
|
|
113
|
+
assignedByUserSourcedId: string | null
|
|
82
114
|
subject: string
|
|
83
115
|
grade: string
|
|
84
116
|
assignmentStatus: TestAssignmentStatus
|
|
85
|
-
testName?: string
|
|
86
|
-
assignedAt?: string
|
|
87
|
-
expiresAt?: string
|
|
88
|
-
completedAt?: string
|
|
89
|
-
resourceSourcedId?: string
|
|
90
|
-
componentResourceSourcedId?: string
|
|
117
|
+
testName?: string | null
|
|
118
|
+
assignedAt?: string | null
|
|
119
|
+
expiresAt?: string | null
|
|
120
|
+
completedAt?: string | null
|
|
121
|
+
resourceSourcedId?: string | null
|
|
122
|
+
componentResourceSourcedId?: string | null
|
|
91
123
|
}
|
|
92
124
|
|
|
93
125
|
/**
|
|
@@ -181,20 +213,70 @@ interface PowerPathTestQuestion {
|
|
|
181
213
|
// ═══════════════════════════════════════════════════════════════════════════════
|
|
182
214
|
|
|
183
215
|
/**
|
|
184
|
-
* Result from creating an external test (test-out
|
|
216
|
+
* Result from creating an external test (test-out or placement).
|
|
185
217
|
*/
|
|
186
218
|
interface ExternalTestCreateResponse {
|
|
219
|
+
/** Type of lesson created. */
|
|
220
|
+
lessonType: PowerPathLessonType
|
|
221
|
+
/** The sourcedId of the created lesson (ComponentResource). */
|
|
222
|
+
lessonId: string
|
|
223
|
+
/** The sourcedId of the component (unit) containing the test. */
|
|
224
|
+
courseComponentId: string
|
|
225
|
+
/** The sourcedId of the resource representing the external test. */
|
|
226
|
+
resourceId: string
|
|
227
|
+
/** URL to the external test system. */
|
|
228
|
+
launchUrl?: string
|
|
229
|
+
/** The tool provider identifier (e.g. 'edulastic', 'mastery-track'). */
|
|
230
|
+
toolProvider: string
|
|
231
|
+
/** The ID of the test in the vendor's system. */
|
|
232
|
+
vendorId?: string
|
|
233
|
+
/** The courseId to enroll the student in on failure (placement tests). */
|
|
234
|
+
courseIdOnFail?: string | null
|
|
235
|
+
/** Grade levels for the resource. */
|
|
236
|
+
grades?: Array<number | string>
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Result from creating an internal test (QTI or assessment-bank).
|
|
241
|
+
*/
|
|
242
|
+
interface InternalTestCreateResponse {
|
|
243
|
+
/** Type of lesson created. */
|
|
244
|
+
lessonType: PowerPathLessonType
|
|
245
|
+
/** The internal test type. */
|
|
246
|
+
testType: 'qti' | 'assessment-bank'
|
|
247
|
+
/** The sourcedId of the created lesson (ComponentResource). */
|
|
187
248
|
lessonId: string
|
|
249
|
+
/** The sourcedId of the component (unit) containing the test. */
|
|
250
|
+
courseComponentId: string
|
|
251
|
+
/** The sourcedId of the main resource (parent for assessment-bank). */
|
|
188
252
|
resourceId: string
|
|
253
|
+
/** Child resource IDs (only for assessment-bank type). */
|
|
254
|
+
childResourceIds?: string[]
|
|
255
|
+
/** The courseId to enroll the student in on failure (placement tests). */
|
|
256
|
+
courseIdOnFail?: string | null
|
|
257
|
+
/** Grade levels for the resource. */
|
|
258
|
+
grades?: Array<number | string>
|
|
189
259
|
}
|
|
190
260
|
|
|
191
261
|
/**
|
|
192
262
|
* A single attempt record.
|
|
263
|
+
*
|
|
264
|
+
* Matches the backend `PowerPath100AttemptSchema` with full metadata
|
|
265
|
+
* including XP, timestamps, and typed score status.
|
|
193
266
|
*/
|
|
194
267
|
interface Attempt {
|
|
195
|
-
|
|
268
|
+
/** Attempt number, or null if not yet started. */
|
|
269
|
+
attempt: number | null
|
|
270
|
+
/** Current score for this attempt. */
|
|
196
271
|
score: number
|
|
197
|
-
|
|
272
|
+
/** Grading status of this attempt. */
|
|
273
|
+
scoreStatus: ScoreStatus
|
|
274
|
+
/** XP earned in this attempt. */
|
|
275
|
+
xp: number | null
|
|
276
|
+
/** When this attempt was started. */
|
|
277
|
+
startedAt: string | null
|
|
278
|
+
/** When this attempt was completed. */
|
|
279
|
+
completedAt: string | null
|
|
198
280
|
}
|
|
199
281
|
|
|
200
282
|
/**
|
|
@@ -395,14 +477,15 @@ type UpdateStudentQuestionResponseResult =
|
|
|
395
477
|
* Result from finalizing a test assessment.
|
|
396
478
|
*
|
|
397
479
|
* Returned after all questions have been answered and the lesson is
|
|
398
|
-
* evaluated.
|
|
480
|
+
* evaluated. Only applicable to quiz-like lesson types (quiz, test-out,
|
|
481
|
+
* placement, unit-test). Not applicable to `powerpath-100`.
|
|
399
482
|
*/
|
|
400
483
|
interface FinalizeAssessmentResponse {
|
|
401
|
-
/** Type of the lesson that was finalized */
|
|
402
|
-
lessonType:
|
|
403
|
-
/** Whether the lesson has been finalized */
|
|
484
|
+
/** Type of the lesson that was finalized (quiz-like only). */
|
|
485
|
+
lessonType: QuizLikeLessonType
|
|
486
|
+
/** Whether the lesson has been finalized. */
|
|
404
487
|
finalized: boolean
|
|
405
|
-
/** The attempt number */
|
|
488
|
+
/** The attempt number. */
|
|
406
489
|
attempt: number
|
|
407
490
|
}
|
|
408
491
|
|
|
@@ -448,10 +531,65 @@ interface TestOutResponse {
|
|
|
448
531
|
/**
|
|
449
532
|
* Result from importing external test assignment results.
|
|
450
533
|
*
|
|
451
|
-
*
|
|
534
|
+
* Contains the lesson reference, finalization status, and optional
|
|
535
|
+
* external tool credentials/assignment data.
|
|
452
536
|
*/
|
|
453
537
|
interface ImportExternalResultsResponse {
|
|
454
|
-
|
|
538
|
+
/** Lesson type (external-capable types only). */
|
|
539
|
+
lessonType: ExternalTestCapableLessonType
|
|
540
|
+
/** The sourcedId of the lesson (ComponentResource). */
|
|
541
|
+
lessonId: string | null
|
|
542
|
+
/** The tool provider for the lesson. */
|
|
543
|
+
toolProvider: string | null
|
|
544
|
+
/** Whether the test has been finalized in the current attempt. */
|
|
545
|
+
finalized: boolean
|
|
546
|
+
/** Attempt number. */
|
|
547
|
+
attempt: number
|
|
548
|
+
/** Credentials for accessing the assigned test on external tool. */
|
|
549
|
+
credentials?: {
|
|
550
|
+
email: string
|
|
551
|
+
password: string
|
|
552
|
+
}
|
|
553
|
+
/** Assignment ID on external tool for results retrieval. */
|
|
554
|
+
assignmentId?: string
|
|
555
|
+
/** Class ID on external tool for results retrieval. */
|
|
556
|
+
classId?: string
|
|
557
|
+
/** URL of the test on external tool. */
|
|
558
|
+
testUrl?: string
|
|
559
|
+
/** ID of the test on external tool. */
|
|
560
|
+
testId?: string
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
// ═══════════════════════════════════════════════════════════════════════════════
|
|
564
|
+
// MAKE EXTERNAL TEST ASSIGNMENT (makeExternalTestAssignment)
|
|
565
|
+
// ═══════════════════════════════════════════════════════════════════════════════
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* Result from assigning an external test to a student.
|
|
569
|
+
*
|
|
570
|
+
* Contains the tool provider, lesson type, attempt number, and optional
|
|
571
|
+
* external tool credentials/assignment data.
|
|
572
|
+
*/
|
|
573
|
+
interface MakeExternalTestAssignmentResponse {
|
|
574
|
+
/** The tool provider (e.g. 'edulastic', 'mastery-track'). */
|
|
575
|
+
toolProvider: string
|
|
576
|
+
/** Lesson type (external-capable types only). */
|
|
577
|
+
lessonType: ExternalTestCapableLessonType
|
|
578
|
+
/** Attempt number. */
|
|
579
|
+
attempt: number
|
|
580
|
+
/** Credentials for accessing the assigned test on external tool. */
|
|
581
|
+
credentials?: {
|
|
582
|
+
email: string
|
|
583
|
+
password: string
|
|
584
|
+
}
|
|
585
|
+
/** Assignment ID on external tool for results retrieval. */
|
|
586
|
+
assignmentId?: string
|
|
587
|
+
/** Class ID on external tool for results retrieval. */
|
|
588
|
+
classId?: string
|
|
589
|
+
/** URL of the test on external tool. */
|
|
590
|
+
testUrl?: string
|
|
591
|
+
/** ID of the test on external tool. */
|
|
592
|
+
testId?: string
|
|
455
593
|
}
|
|
456
594
|
|
|
457
595
|
// ═══════════════════════════════════════════════════════════════════════════════
|
|
@@ -645,7 +783,7 @@ declare const ExternalTestOut = ExternalTestBase.extend({
|
|
|
645
783
|
|
|
646
784
|
declare const ExternalPlacement = ExternalTestBase.extend({
|
|
647
785
|
lessonType: z.literal('placement'),
|
|
648
|
-
courseIdOnFail: NonEmptyString.optional(),
|
|
786
|
+
courseIdOnFail: NonEmptyString.nullable().optional(),
|
|
649
787
|
xp: z.number().optional(),
|
|
650
788
|
})
|
|
651
789
|
|
|
@@ -653,7 +791,7 @@ declare const PowerPathCreateExternalPlacementTestInput = ExternalPlacement
|
|
|
653
791
|
|
|
654
792
|
declare const PowerPathCreateExternalTestOutInput = ExternalTestOut
|
|
655
793
|
|
|
656
|
-
declare const PowerPathCreateInternalTestInput = z.
|
|
794
|
+
declare const PowerPathCreateInternalTestInput = z.discriminatedUnion('testType', [
|
|
657
795
|
InternalTestBase.extend({
|
|
658
796
|
testType: z.literal('qti'),
|
|
659
797
|
qti: z.object({
|
|
@@ -665,13 +803,15 @@ declare const PowerPathCreateInternalTestInput = z.union([
|
|
|
665
803
|
InternalTestBase.extend({
|
|
666
804
|
testType: z.literal('assessment-bank'),
|
|
667
805
|
assessmentBank: z.object({
|
|
668
|
-
resources: z
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
806
|
+
resources: z
|
|
807
|
+
.array(
|
|
808
|
+
z.object({
|
|
809
|
+
url: z.url(),
|
|
810
|
+
title: NonEmptyString.optional(),
|
|
811
|
+
metadata: z.record(z.string(), z.unknown()).optional(),
|
|
812
|
+
}),
|
|
813
|
+
)
|
|
814
|
+
.min(1),
|
|
675
815
|
}),
|
|
676
816
|
}),
|
|
677
817
|
])
|
|
@@ -858,6 +998,17 @@ declare const PowerPathUpdateStudentQuestionResponseInput = z.object({
|
|
|
858
998
|
responses: z.record(z.string(), z.union([NonEmptyString, z.array(NonEmptyString)])).optional(),
|
|
859
999
|
lesson: NonEmptyString,
|
|
860
1000
|
})
|
|
1001
|
+
.refine((data) => data.response !== undefined || data.responses !== undefined, {
|
|
1002
|
+
message: "Either 'response' or 'responses' must be provided",
|
|
1003
|
+
path: ['response', 'responses'],
|
|
1004
|
+
})
|
|
1005
|
+
.transform((data) => {
|
|
1006
|
+
if (data.response !== undefined && data.responses === undefined) {
|
|
1007
|
+
return { ...data, responses: { RESPONSE: data.response } }
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
return data
|
|
1011
|
+
})
|
|
861
1012
|
|
|
862
1013
|
declare const PowerPathGetAssessmentProgressParams = z.object({
|
|
863
1014
|
student: NonEmptyString,
|
|
@@ -877,10 +1028,7 @@ declare const PowerPathGetAttemptsParams = z.object({
|
|
|
877
1028
|
|
|
878
1029
|
declare const PowerPathTestOutParams = z.object({
|
|
879
1030
|
student: NonEmptyString,
|
|
880
|
-
|
|
881
|
-
finalized: z.boolean().optional(),
|
|
882
|
-
toolProvider: NonEmptyString.optional(),
|
|
883
|
-
attempt: z.number().int().positive().optional(),
|
|
1031
|
+
course: NonEmptyString,
|
|
884
1032
|
})
|
|
885
1033
|
|
|
886
1034
|
declare const PowerPathImportExternalTestAssignmentResultsParams = z.object({
|
|
@@ -1002,14 +1150,14 @@ declare class AssessmentResource {
|
|
|
1002
1150
|
constructor(transport: PowerPathTransportLike);
|
|
1003
1151
|
createExternalPlacementTest(input: CreateExternalPlacementTestInput): Promise<ExternalTestCreateResponse>;
|
|
1004
1152
|
createExternalTestOut(input: CreateExternalTestOutInput): Promise<ExternalTestCreateResponse>;
|
|
1005
|
-
createInternalTest(input: CreateInternalTestInput): Promise<
|
|
1153
|
+
createInternalTest(input: CreateInternalTestInput): Promise<InternalTestCreateResponse>;
|
|
1006
1154
|
createNewAttempt(input: CreateNewAttemptInput): Promise<CreateAttemptResponse>;
|
|
1007
1155
|
finalStudentAssessmentResponse(input: FinalStudentAssessmentResponseInput): Promise<FinalizeAssessmentResponse>;
|
|
1008
1156
|
getAssessmentProgress(params: GetAssessmentProgressParams): Promise<GetAssessmentProgressResponse>;
|
|
1009
1157
|
getAttempts(params: GetAttemptsParams): Promise<GetAttemptsResponse>;
|
|
1010
1158
|
getNextQuestion(params: GetNextQuestionParams): Promise<GetNextQuestionResponse>;
|
|
1011
1159
|
importExternalTestAssignmentResults(params: ImportExternalTestAssignmentResultsParams): Promise<ImportExternalResultsResponse>;
|
|
1012
|
-
makeExternalTestAssignment(input: MakeExternalTestAssignmentInput): Promise<
|
|
1160
|
+
makeExternalTestAssignment(input: MakeExternalTestAssignmentInput): Promise<MakeExternalTestAssignmentResponse>;
|
|
1013
1161
|
resetAttempt(input: ResetAttemptInput): Promise<ResetAttemptResponse>;
|
|
1014
1162
|
testOut(params: TestOutParams): Promise<TestOutResponse>;
|
|
1015
1163
|
updateStudentQuestionResponse(input: UpdateStudentQuestionResponseInput): Promise<UpdateStudentQuestionResponseResult>;
|
|
@@ -1323,4 +1471,4 @@ declare class Transport extends BaseTransport {
|
|
|
1323
1471
|
}
|
|
1324
1472
|
|
|
1325
1473
|
export { Paginator, PowerPathClient, Transport, createPowerPathClient };
|
|
1326
|
-
export type { AssignmentResult, Attempt, BulkResult, CourseProgressResponse, CreateAttemptResponse, CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, ExternalTestCreateResponse, FinalStudentAssessmentResponseInput, FinalizeAssessmentResponse, GetAllPlacementTestsResponse, GetAssessmentProgressParams, GetAssessmentProgressResponse, GetAttemptsParams, GetAttemptsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetNextQuestionParams, GetNextQuestionResponse, GetSubjectProgressResponse, ImportExternalResultsResponse, ImportExternalTestAssignmentResultsParams, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationInput, LessonPlanOperationResult, LessonPlanOperationsInput, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, LessonPlanUpdateStudentItemResponseInput, LessonPlansCreateInput, MakeExternalTestAssignmentInput, PaginationMeta, PlacementQueryParams, PlacementResetUserPlacementInput, PowerPath100ProgressResponse, PowerPath100UpdateResponseResult, PowerPathClientConfig, PowerPathClientInstance, PowerPathLessonType, PowerPathQuestionContent, PowerPathQuestionDifficulty, PowerPathQuestionResult, PowerPathTestQuestion, ResetAttemptInput, ResetAttemptResponse, ResetPlacementResponse, ResponseResult, ResponseResultFeedback, ScreeningAssignTestInput, ScreeningAssignTestResponse, ScreeningResetSessionInput, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, StandardProgressResponse, StandardUpdateResponseResult, SyllabusQueryParams, SyllabusResponse, TestAssignment, TestAssignmentStatus, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsListResponse, TestAssignmentsUpdateInput, TestOutParams, TestOutResponse, UpdateStudentItemResponseResult, UpdateStudentQuestionResponseInput, UpdateStudentQuestionResponseResult };
|
|
1474
|
+
export type { AssignmentResult, Attempt, BulkResult, CourseProgressResponse, CreateAttemptResponse, CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, ExternalTestCapableLessonType, ExternalTestCreateResponse, FinalStudentAssessmentResponseInput, FinalizeAssessmentResponse, GetAllPlacementTestsResponse, GetAssessmentProgressParams, GetAssessmentProgressResponse, GetAttemptsParams, GetAttemptsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetNextQuestionParams, GetNextQuestionResponse, GetSubjectProgressResponse, ImportExternalResultsResponse, ImportExternalTestAssignmentResultsParams, InternalTestCreateResponse, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationInput, LessonPlanOperationResult, LessonPlanOperationsInput, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, LessonPlanUpdateStudentItemResponseInput, LessonPlansCreateInput, MakeExternalTestAssignmentInput, MakeExternalTestAssignmentResponse, PaginationMeta, PlacementQueryParams, PlacementResetUserPlacementInput, PowerPath100ProgressResponse, PowerPath100UpdateResponseResult, PowerPathClientConfig, PowerPathClientInstance, PowerPathLessonType, PowerPathQuestionContent, PowerPathQuestionDifficulty, PowerPathQuestionResult, PowerPathTestQuestion, QuizLikeLessonType, ResetAttemptInput, ResetAttemptResponse, ResetPlacementResponse, ResponseResult, ResponseResultFeedback, ScoreStatus, ScreeningAssignTestInput, ScreeningAssignTestResponse, ScreeningResetSessionInput, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, StandardProgressResponse, StandardUpdateResponseResult, SyllabusQueryParams, SyllabusResponse, TestAssignment, TestAssignmentStatus, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsListResponse, TestAssignmentsUpdateInput, TestOutParams, TestOutResponse, UpdateStudentItemResponseResult, UpdateStudentQuestionResponseInput, UpdateStudentQuestionResponseResult };
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAMH,OAAO,EAAE,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAM3D,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAE9F,YAAY,EAEX,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAE3B,OAAO,EACP,qBAAqB,EACrB,0BAA0B,EAC1B,0BAA0B,EAC1B,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,gCAAgC,EAChC,wBAAwB,EACxB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,eAAe,EACf,mCAAmC,EAEnC,4BAA4B,EAC5B,uBAAuB,EACvB,4BAA4B,EAC5B,0BAA0B,EAC1B,sBAAsB,EAEtB,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,wBAAwB,EAExB,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,4BAA4B,EAC5B,kBAAkB,EAClB,oBAAoB,EACpB,+BAA+B,EAE/B,gBAAgB,EAEhB,cAAc,EACd,mBAAmB,EACnB,2BAA2B,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAMH,OAAO,EAAE,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAM3D,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAE9F,YAAY,EAEX,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAE3B,OAAO,EACP,qBAAqB,EACrB,0BAA0B,EAC1B,0BAA0B,EAC1B,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EACvB,6BAA6B,EAC7B,0BAA0B,EAC1B,kCAAkC,EAClC,4BAA4B,EAC5B,gCAAgC,EAChC,wBAAwB,EACxB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,eAAe,EACf,mCAAmC,EAEnC,4BAA4B,EAC5B,uBAAuB,EACvB,4BAA4B,EAC5B,0BAA0B,EAC1B,sBAAsB,EAEtB,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,wBAAwB,EAExB,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,4BAA4B,EAC5B,kBAAkB,EAClB,oBAAoB,EACpB,+BAA+B,EAE/B,gBAAgB,EAEhB,6BAA6B,EAC7B,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,kBAAkB,EAClB,WAAW,GACX,MAAM,qCAAqC,CAAA;AAM5C,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;AAM5B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -16678,7 +16678,7 @@ var ResourceMetadata = exports_external.record(exports_external.string(), export
|
|
|
16678
16678
|
var ExternalTestBase = exports_external.object({
|
|
16679
16679
|
courseId: NonEmptyString6,
|
|
16680
16680
|
lessonTitle: NonEmptyString6.optional(),
|
|
16681
|
-
launchUrl:
|
|
16681
|
+
launchUrl: NonEmptyString6.optional(),
|
|
16682
16682
|
toolProvider: ToolProvider,
|
|
16683
16683
|
unitTitle: NonEmptyString6.optional(),
|
|
16684
16684
|
courseComponentSourcedId: NonEmptyString6.optional(),
|
|
@@ -16693,7 +16693,7 @@ var ExternalTestOut = ExternalTestBase.extend({
|
|
|
16693
16693
|
});
|
|
16694
16694
|
var ExternalPlacement = ExternalTestBase.extend({
|
|
16695
16695
|
lessonType: exports_external.literal("placement"),
|
|
16696
|
-
courseIdOnFail: NonEmptyString6.optional(),
|
|
16696
|
+
courseIdOnFail: NonEmptyString6.nullable().optional(),
|
|
16697
16697
|
xp: exports_external.number().optional()
|
|
16698
16698
|
});
|
|
16699
16699
|
var PowerPathCreateExternalPlacementTestInput = ExternalPlacement;
|
|
@@ -16707,9 +16707,9 @@ var InternalTestBase = exports_external.object({
|
|
|
16707
16707
|
resourceMetadata: ResourceMetadata.nullable().optional(),
|
|
16708
16708
|
xp: exports_external.number().optional(),
|
|
16709
16709
|
grades: GradeArray.optional(),
|
|
16710
|
-
courseIdOnFail: NonEmptyString6.optional()
|
|
16710
|
+
courseIdOnFail: NonEmptyString6.nullable().optional()
|
|
16711
16711
|
});
|
|
16712
|
-
var PowerPathCreateInternalTestInput = exports_external.
|
|
16712
|
+
var PowerPathCreateInternalTestInput = exports_external.discriminatedUnion("testType", [
|
|
16713
16713
|
InternalTestBase.extend({
|
|
16714
16714
|
testType: exports_external.literal("qti"),
|
|
16715
16715
|
qti: exports_external.object({
|
|
@@ -16725,7 +16725,7 @@ var PowerPathCreateInternalTestInput = exports_external.union([
|
|
|
16725
16725
|
url: exports_external.url(),
|
|
16726
16726
|
title: NonEmptyString6.optional(),
|
|
16727
16727
|
metadata: exports_external.record(exports_external.string(), exports_external.unknown()).optional()
|
|
16728
|
-
}))
|
|
16728
|
+
})).min(1)
|
|
16729
16729
|
})
|
|
16730
16730
|
})
|
|
16731
16731
|
]);
|
|
@@ -16893,6 +16893,14 @@ var PowerPathUpdateStudentQuestionResponseInput = exports_external.object({
|
|
|
16893
16893
|
response: exports_external.union([NonEmptyString6, exports_external.array(NonEmptyString6)]).optional(),
|
|
16894
16894
|
responses: exports_external.record(exports_external.string(), exports_external.union([NonEmptyString6, exports_external.array(NonEmptyString6)])).optional(),
|
|
16895
16895
|
lesson: NonEmptyString6
|
|
16896
|
+
}).refine((data) => data.response !== undefined || data.responses !== undefined, {
|
|
16897
|
+
message: "Either 'response' or 'responses' must be provided",
|
|
16898
|
+
path: ["response", "responses"]
|
|
16899
|
+
}).transform((data) => {
|
|
16900
|
+
if (data.response !== undefined && data.responses === undefined) {
|
|
16901
|
+
return { ...data, responses: { RESPONSE: data.response } };
|
|
16902
|
+
}
|
|
16903
|
+
return data;
|
|
16896
16904
|
});
|
|
16897
16905
|
var PowerPathGetAssessmentProgressParams = exports_external.object({
|
|
16898
16906
|
student: NonEmptyString6,
|
|
@@ -16909,10 +16917,7 @@ var PowerPathGetAttemptsParams = exports_external.object({
|
|
|
16909
16917
|
});
|
|
16910
16918
|
var PowerPathTestOutParams = exports_external.object({
|
|
16911
16919
|
student: NonEmptyString6,
|
|
16912
|
-
|
|
16913
|
-
finalized: exports_external.boolean().optional(),
|
|
16914
|
-
toolProvider: NonEmptyString6.optional(),
|
|
16915
|
-
attempt: exports_external.number().int().positive().optional()
|
|
16920
|
+
course: NonEmptyString6
|
|
16916
16921
|
});
|
|
16917
16922
|
var PowerPathImportExternalTestAssignmentResultsParams = exports_external.object({
|
|
16918
16923
|
student: NonEmptyString6,
|
|
@@ -17094,8 +17099,8 @@ var QtiAssessmentItemProcessResponseInput = exports_external.object({
|
|
|
17094
17099
|
}).strict();
|
|
17095
17100
|
var QtiAssessmentItemRef = exports_external.object({
|
|
17096
17101
|
identifier: exports_external.string().min(1),
|
|
17097
|
-
href: exports_external.
|
|
17098
|
-
sequence: exports_external.number().optional()
|
|
17102
|
+
href: exports_external.string().min(1),
|
|
17103
|
+
sequence: exports_external.number().int().positive().optional()
|
|
17099
17104
|
}).strict();
|
|
17100
17105
|
var QtiAssessmentSection = exports_external.object({
|
|
17101
17106
|
identifier: exports_external.string().min(1),
|
|
@@ -17103,7 +17108,7 @@ var QtiAssessmentSection = exports_external.object({
|
|
|
17103
17108
|
visible: exports_external.boolean(),
|
|
17104
17109
|
required: exports_external.boolean().optional(),
|
|
17105
17110
|
fixed: exports_external.boolean().optional(),
|
|
17106
|
-
sequence: exports_external.number().
|
|
17111
|
+
sequence: exports_external.number().int().positive(),
|
|
17107
17112
|
"qti-assessment-item-ref": exports_external.array(QtiAssessmentItemRef).optional()
|
|
17108
17113
|
}).strict();
|
|
17109
17114
|
var QtiTestPart = exports_external.object({
|
package/dist/public-types.d.ts
CHANGED
|
@@ -22,7 +22,39 @@ type TestAssignmentStatus =
|
|
|
22
22
|
/**
|
|
23
23
|
* Lesson types for PowerPath assessments.
|
|
24
24
|
*/
|
|
25
|
-
type PowerPathLessonType =
|
|
25
|
+
type PowerPathLessonType =
|
|
26
|
+
| 'powerpath-100'
|
|
27
|
+
| 'quiz'
|
|
28
|
+
| 'test-out'
|
|
29
|
+
| 'placement'
|
|
30
|
+
| 'unit-test'
|
|
31
|
+
| 'alpha-read-article'
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Lesson types that behave like quizzes (static tests with finalization).
|
|
35
|
+
*
|
|
36
|
+
* These types can be finalized via `finalStudentAssessmentResponse`,
|
|
37
|
+
* return score 0 while not finalized, and support both internal and external tests.
|
|
38
|
+
*/
|
|
39
|
+
type QuizLikeLessonType = 'quiz' | 'test-out' | 'placement' | 'unit-test'
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Lesson types that support external test assignment via third-party tools.
|
|
43
|
+
*
|
|
44
|
+
* These types can use `makeExternalTestAssignment` and
|
|
45
|
+
* `importExternalTestAssignmentResults`.
|
|
46
|
+
*/
|
|
47
|
+
type ExternalTestCapableLessonType = 'test-out' | 'placement' | 'unit-test'
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Score status values for assessment attempts.
|
|
51
|
+
*/
|
|
52
|
+
type ScoreStatus =
|
|
53
|
+
| 'exempt'
|
|
54
|
+
| 'fully graded'
|
|
55
|
+
| 'not submitted'
|
|
56
|
+
| 'partially graded'
|
|
57
|
+
| 'submitted'
|
|
26
58
|
|
|
27
59
|
/**
|
|
28
60
|
* Question difficulty levels.
|
|
@@ -86,16 +118,16 @@ interface TestAssignment {
|
|
|
86
118
|
sourcedId: string
|
|
87
119
|
studentSourcedId: string
|
|
88
120
|
studentEmail: string
|
|
89
|
-
assignedByUserSourcedId
|
|
121
|
+
assignedByUserSourcedId: string | null
|
|
90
122
|
subject: string
|
|
91
123
|
grade: string
|
|
92
124
|
assignmentStatus: TestAssignmentStatus
|
|
93
|
-
testName?: string
|
|
94
|
-
assignedAt?: string
|
|
95
|
-
expiresAt?: string
|
|
96
|
-
completedAt?: string
|
|
97
|
-
resourceSourcedId?: string
|
|
98
|
-
componentResourceSourcedId?: string
|
|
125
|
+
testName?: string | null
|
|
126
|
+
assignedAt?: string | null
|
|
127
|
+
expiresAt?: string | null
|
|
128
|
+
completedAt?: string | null
|
|
129
|
+
resourceSourcedId?: string | null
|
|
130
|
+
componentResourceSourcedId?: string | null
|
|
99
131
|
}
|
|
100
132
|
|
|
101
133
|
/**
|
|
@@ -189,20 +221,70 @@ interface PowerPathTestQuestion {
|
|
|
189
221
|
// ═══════════════════════════════════════════════════════════════════════════════
|
|
190
222
|
|
|
191
223
|
/**
|
|
192
|
-
* Result from creating an external test (test-out
|
|
224
|
+
* Result from creating an external test (test-out or placement).
|
|
193
225
|
*/
|
|
194
226
|
interface ExternalTestCreateResponse {
|
|
227
|
+
/** Type of lesson created. */
|
|
228
|
+
lessonType: PowerPathLessonType
|
|
229
|
+
/** The sourcedId of the created lesson (ComponentResource). */
|
|
230
|
+
lessonId: string
|
|
231
|
+
/** The sourcedId of the component (unit) containing the test. */
|
|
232
|
+
courseComponentId: string
|
|
233
|
+
/** The sourcedId of the resource representing the external test. */
|
|
234
|
+
resourceId: string
|
|
235
|
+
/** URL to the external test system. */
|
|
236
|
+
launchUrl?: string
|
|
237
|
+
/** The tool provider identifier (e.g. 'edulastic', 'mastery-track'). */
|
|
238
|
+
toolProvider: string
|
|
239
|
+
/** The ID of the test in the vendor's system. */
|
|
240
|
+
vendorId?: string
|
|
241
|
+
/** The courseId to enroll the student in on failure (placement tests). */
|
|
242
|
+
courseIdOnFail?: string | null
|
|
243
|
+
/** Grade levels for the resource. */
|
|
244
|
+
grades?: Array<number | string>
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Result from creating an internal test (QTI or assessment-bank).
|
|
249
|
+
*/
|
|
250
|
+
interface InternalTestCreateResponse {
|
|
251
|
+
/** Type of lesson created. */
|
|
252
|
+
lessonType: PowerPathLessonType
|
|
253
|
+
/** The internal test type. */
|
|
254
|
+
testType: 'qti' | 'assessment-bank'
|
|
255
|
+
/** The sourcedId of the created lesson (ComponentResource). */
|
|
195
256
|
lessonId: string
|
|
257
|
+
/** The sourcedId of the component (unit) containing the test. */
|
|
258
|
+
courseComponentId: string
|
|
259
|
+
/** The sourcedId of the main resource (parent for assessment-bank). */
|
|
196
260
|
resourceId: string
|
|
261
|
+
/** Child resource IDs (only for assessment-bank type). */
|
|
262
|
+
childResourceIds?: string[]
|
|
263
|
+
/** The courseId to enroll the student in on failure (placement tests). */
|
|
264
|
+
courseIdOnFail?: string | null
|
|
265
|
+
/** Grade levels for the resource. */
|
|
266
|
+
grades?: Array<number | string>
|
|
197
267
|
}
|
|
198
268
|
|
|
199
269
|
/**
|
|
200
270
|
* A single attempt record.
|
|
271
|
+
*
|
|
272
|
+
* Matches the backend `PowerPath100AttemptSchema` with full metadata
|
|
273
|
+
* including XP, timestamps, and typed score status.
|
|
201
274
|
*/
|
|
202
275
|
interface Attempt {
|
|
203
|
-
|
|
276
|
+
/** Attempt number, or null if not yet started. */
|
|
277
|
+
attempt: number | null
|
|
278
|
+
/** Current score for this attempt. */
|
|
204
279
|
score: number
|
|
205
|
-
|
|
280
|
+
/** Grading status of this attempt. */
|
|
281
|
+
scoreStatus: ScoreStatus
|
|
282
|
+
/** XP earned in this attempt. */
|
|
283
|
+
xp: number | null
|
|
284
|
+
/** When this attempt was started. */
|
|
285
|
+
startedAt: string | null
|
|
286
|
+
/** When this attempt was completed. */
|
|
287
|
+
completedAt: string | null
|
|
206
288
|
}
|
|
207
289
|
|
|
208
290
|
/**
|
|
@@ -403,14 +485,15 @@ type UpdateStudentQuestionResponseResult =
|
|
|
403
485
|
* Result from finalizing a test assessment.
|
|
404
486
|
*
|
|
405
487
|
* Returned after all questions have been answered and the lesson is
|
|
406
|
-
* evaluated.
|
|
488
|
+
* evaluated. Only applicable to quiz-like lesson types (quiz, test-out,
|
|
489
|
+
* placement, unit-test). Not applicable to `powerpath-100`.
|
|
407
490
|
*/
|
|
408
491
|
interface FinalizeAssessmentResponse {
|
|
409
|
-
/** Type of the lesson that was finalized */
|
|
410
|
-
lessonType:
|
|
411
|
-
/** Whether the lesson has been finalized */
|
|
492
|
+
/** Type of the lesson that was finalized (quiz-like only). */
|
|
493
|
+
lessonType: QuizLikeLessonType
|
|
494
|
+
/** Whether the lesson has been finalized. */
|
|
412
495
|
finalized: boolean
|
|
413
|
-
/** The attempt number */
|
|
496
|
+
/** The attempt number. */
|
|
414
497
|
attempt: number
|
|
415
498
|
}
|
|
416
499
|
|
|
@@ -456,10 +539,65 @@ interface TestOutResponse {
|
|
|
456
539
|
/**
|
|
457
540
|
* Result from importing external test assignment results.
|
|
458
541
|
*
|
|
459
|
-
*
|
|
542
|
+
* Contains the lesson reference, finalization status, and optional
|
|
543
|
+
* external tool credentials/assignment data.
|
|
460
544
|
*/
|
|
461
545
|
interface ImportExternalResultsResponse {
|
|
462
|
-
|
|
546
|
+
/** Lesson type (external-capable types only). */
|
|
547
|
+
lessonType: ExternalTestCapableLessonType
|
|
548
|
+
/** The sourcedId of the lesson (ComponentResource). */
|
|
549
|
+
lessonId: string | null
|
|
550
|
+
/** The tool provider for the lesson. */
|
|
551
|
+
toolProvider: string | null
|
|
552
|
+
/** Whether the test has been finalized in the current attempt. */
|
|
553
|
+
finalized: boolean
|
|
554
|
+
/** Attempt number. */
|
|
555
|
+
attempt: number
|
|
556
|
+
/** Credentials for accessing the assigned test on external tool. */
|
|
557
|
+
credentials?: {
|
|
558
|
+
email: string
|
|
559
|
+
password: string
|
|
560
|
+
}
|
|
561
|
+
/** Assignment ID on external tool for results retrieval. */
|
|
562
|
+
assignmentId?: string
|
|
563
|
+
/** Class ID on external tool for results retrieval. */
|
|
564
|
+
classId?: string
|
|
565
|
+
/** URL of the test on external tool. */
|
|
566
|
+
testUrl?: string
|
|
567
|
+
/** ID of the test on external tool. */
|
|
568
|
+
testId?: string
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
// ═══════════════════════════════════════════════════════════════════════════════
|
|
572
|
+
// MAKE EXTERNAL TEST ASSIGNMENT (makeExternalTestAssignment)
|
|
573
|
+
// ═══════════════════════════════════════════════════════════════════════════════
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Result from assigning an external test to a student.
|
|
577
|
+
*
|
|
578
|
+
* Contains the tool provider, lesson type, attempt number, and optional
|
|
579
|
+
* external tool credentials/assignment data.
|
|
580
|
+
*/
|
|
581
|
+
interface MakeExternalTestAssignmentResponse {
|
|
582
|
+
/** The tool provider (e.g. 'edulastic', 'mastery-track'). */
|
|
583
|
+
toolProvider: string
|
|
584
|
+
/** Lesson type (external-capable types only). */
|
|
585
|
+
lessonType: ExternalTestCapableLessonType
|
|
586
|
+
/** Attempt number. */
|
|
587
|
+
attempt: number
|
|
588
|
+
/** Credentials for accessing the assigned test on external tool. */
|
|
589
|
+
credentials?: {
|
|
590
|
+
email: string
|
|
591
|
+
password: string
|
|
592
|
+
}
|
|
593
|
+
/** Assignment ID on external tool for results retrieval. */
|
|
594
|
+
assignmentId?: string
|
|
595
|
+
/** Class ID on external tool for results retrieval. */
|
|
596
|
+
classId?: string
|
|
597
|
+
/** URL of the test on external tool. */
|
|
598
|
+
testUrl?: string
|
|
599
|
+
/** ID of the test on external tool. */
|
|
600
|
+
testId?: string
|
|
463
601
|
}
|
|
464
602
|
|
|
465
603
|
// ═══════════════════════════════════════════════════════════════════════════════
|
|
@@ -653,7 +791,7 @@ declare const ExternalTestOut = ExternalTestBase.extend({
|
|
|
653
791
|
|
|
654
792
|
declare const ExternalPlacement = ExternalTestBase.extend({
|
|
655
793
|
lessonType: z.literal('placement'),
|
|
656
|
-
courseIdOnFail: NonEmptyString.optional(),
|
|
794
|
+
courseIdOnFail: NonEmptyString.nullable().optional(),
|
|
657
795
|
xp: z.number().optional(),
|
|
658
796
|
})
|
|
659
797
|
|
|
@@ -661,7 +799,7 @@ declare const PowerPathCreateExternalPlacementTestInput = ExternalPlacement
|
|
|
661
799
|
|
|
662
800
|
declare const PowerPathCreateExternalTestOutInput = ExternalTestOut
|
|
663
801
|
|
|
664
|
-
declare const PowerPathCreateInternalTestInput = z.
|
|
802
|
+
declare const PowerPathCreateInternalTestInput = z.discriminatedUnion('testType', [
|
|
665
803
|
InternalTestBase.extend({
|
|
666
804
|
testType: z.literal('qti'),
|
|
667
805
|
qti: z.object({
|
|
@@ -673,13 +811,15 @@ declare const PowerPathCreateInternalTestInput = z.union([
|
|
|
673
811
|
InternalTestBase.extend({
|
|
674
812
|
testType: z.literal('assessment-bank'),
|
|
675
813
|
assessmentBank: z.object({
|
|
676
|
-
resources: z
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
814
|
+
resources: z
|
|
815
|
+
.array(
|
|
816
|
+
z.object({
|
|
817
|
+
url: z.url(),
|
|
818
|
+
title: NonEmptyString.optional(),
|
|
819
|
+
metadata: z.record(z.string(), z.unknown()).optional(),
|
|
820
|
+
}),
|
|
821
|
+
)
|
|
822
|
+
.min(1),
|
|
683
823
|
}),
|
|
684
824
|
}),
|
|
685
825
|
])
|
|
@@ -866,6 +1006,17 @@ declare const PowerPathUpdateStudentQuestionResponseInput = z.object({
|
|
|
866
1006
|
responses: z.record(z.string(), z.union([NonEmptyString, z.array(NonEmptyString)])).optional(),
|
|
867
1007
|
lesson: NonEmptyString,
|
|
868
1008
|
})
|
|
1009
|
+
.refine((data) => data.response !== undefined || data.responses !== undefined, {
|
|
1010
|
+
message: "Either 'response' or 'responses' must be provided",
|
|
1011
|
+
path: ['response', 'responses'],
|
|
1012
|
+
})
|
|
1013
|
+
.transform((data) => {
|
|
1014
|
+
if (data.response !== undefined && data.responses === undefined) {
|
|
1015
|
+
return { ...data, responses: { RESPONSE: data.response } }
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
return data
|
|
1019
|
+
})
|
|
869
1020
|
|
|
870
1021
|
declare const PowerPathGetAssessmentProgressParams = z.object({
|
|
871
1022
|
student: NonEmptyString,
|
|
@@ -885,10 +1036,7 @@ declare const PowerPathGetAttemptsParams = z.object({
|
|
|
885
1036
|
|
|
886
1037
|
declare const PowerPathTestOutParams = z.object({
|
|
887
1038
|
student: NonEmptyString,
|
|
888
|
-
|
|
889
|
-
finalized: z.boolean().optional(),
|
|
890
|
-
toolProvider: NonEmptyString.optional(),
|
|
891
|
-
attempt: z.number().int().positive().optional(),
|
|
1039
|
+
course: NonEmptyString,
|
|
892
1040
|
})
|
|
893
1041
|
|
|
894
1042
|
declare const PowerPathImportExternalTestAssignmentResultsParams = z.object({
|
|
@@ -954,4 +1102,4 @@ type ImportExternalTestAssignmentResultsParams = input<
|
|
|
954
1102
|
type PlacementQueryParams = input<typeof PowerPathPlacementQueryParams>
|
|
955
1103
|
type SyllabusQueryParams = input<typeof PowerPathSyllabusQueryParams>
|
|
956
1104
|
|
|
957
|
-
export type { AssignmentResult, Attempt, BulkResult, CourseProgressResponse, CreateAttemptResponse, CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, ExternalTestCreateResponse, FinalStudentAssessmentResponseInput, FinalizeAssessmentResponse, GetAllPlacementTestsResponse, GetAssessmentProgressParams, GetAssessmentProgressResponse, GetAttemptsParams, GetAttemptsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetNextQuestionParams, GetNextQuestionResponse, GetSubjectProgressResponse, ImportExternalResultsResponse, ImportExternalTestAssignmentResultsParams, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationInput, LessonPlanOperationResult, LessonPlanOperationType, LessonPlanOperationsInput, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, LessonPlanUpdateStudentItemResponseInput, LessonPlansCreateInput, MakeExternalTestAssignmentInput, PaginationMeta, PlacementQueryParams, PlacementResetUserPlacementInput, PowerPath100ProgressResponse, PowerPath100UpdateResponseResult, PowerPathLessonType, PowerPathQuestionContent, PowerPathQuestionDifficulty, PowerPathQuestionResult, PowerPathTestQuestion, ResetAttemptInput, ResetAttemptResponse, ResetPlacementResponse, ResponseResult, ResponseResultFeedback, ScreeningAssignTestInput, ScreeningAssignTestResponse, ScreeningResetSessionInput, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, StandardProgressResponse, StandardUpdateResponseResult, SyllabusQueryParams, SyllabusResponse, TestAssignment, TestAssignmentStatus, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsListResponse, TestAssignmentsUpdateInput, TestOutParams, TestOutResponse, UpdateStudentItemResponseResult, UpdateStudentQuestionResponseInput, UpdateStudentQuestionResponseResult };
|
|
1105
|
+
export type { AssignmentResult, Attempt, BulkResult, CourseProgressResponse, CreateAttemptResponse, CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, ExternalTestCapableLessonType, ExternalTestCreateResponse, FinalStudentAssessmentResponseInput, FinalizeAssessmentResponse, GetAllPlacementTestsResponse, GetAssessmentProgressParams, GetAssessmentProgressResponse, GetAttemptsParams, GetAttemptsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetNextQuestionParams, GetNextQuestionResponse, GetSubjectProgressResponse, ImportExternalResultsResponse, ImportExternalTestAssignmentResultsParams, InternalTestCreateResponse, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationInput, LessonPlanOperationResult, LessonPlanOperationType, LessonPlanOperationsInput, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, LessonPlanUpdateStudentItemResponseInput, LessonPlansCreateInput, MakeExternalTestAssignmentInput, MakeExternalTestAssignmentResponse, PaginationMeta, PlacementQueryParams, PlacementResetUserPlacementInput, PowerPath100ProgressResponse, PowerPath100UpdateResponseResult, PowerPathLessonType, PowerPathQuestionContent, PowerPathQuestionDifficulty, PowerPathQuestionResult, PowerPathTestQuestion, QuizLikeLessonType, ResetAttemptInput, ResetAttemptResponse, ResetPlacementResponse, ResponseResult, ResponseResultFeedback, ScoreStatus, ScreeningAssignTestInput, ScreeningAssignTestResponse, ScreeningResetSessionInput, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, StandardProgressResponse, StandardUpdateResponseResult, SyllabusQueryParams, SyllabusResponse, TestAssignment, TestAssignmentStatus, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsListResponse, TestAssignmentsUpdateInput, TestOutParams, TestOutResponse, UpdateStudentItemResponseResult, UpdateStudentQuestionResponseInput, UpdateStudentQuestionResponseResult };
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* PowerPath assessment operations: tests, attempts, and responses.
|
|
5
5
|
*/
|
|
6
|
-
import type { CreateAttemptResponse, ExternalTestCreateResponse, FinalizeAssessmentResponse, GetAssessmentProgressResponse, GetAttemptsResponse, GetNextQuestionResponse, ImportExternalResultsResponse, ResetAttemptResponse, TestOutResponse, UpdateStudentQuestionResponseResult } from '@timeback/types/protocols/powerpath';
|
|
6
|
+
import type { CreateAttemptResponse, ExternalTestCreateResponse, FinalizeAssessmentResponse, GetAssessmentProgressResponse, GetAttemptsResponse, GetNextQuestionResponse, ImportExternalResultsResponse, InternalTestCreateResponse, MakeExternalTestAssignmentResponse, ResetAttemptResponse, TestOutResponse, UpdateStudentQuestionResponseResult } from '@timeback/types/protocols/powerpath';
|
|
7
7
|
import type { CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, FinalStudentAssessmentResponseInput, GetAssessmentProgressParams, GetAttemptsParams, GetNextQuestionParams, ImportExternalTestAssignmentResultsParams, MakeExternalTestAssignmentInput, ResetAttemptInput, TestOutParams, UpdateStudentQuestionResponseInput } from '@timeback/types/zod';
|
|
8
8
|
import type { PowerPathTransportLike } from '../types';
|
|
9
9
|
/**
|
|
@@ -14,14 +14,14 @@ export declare class AssessmentResource {
|
|
|
14
14
|
constructor(transport: PowerPathTransportLike);
|
|
15
15
|
createExternalPlacementTest(input: CreateExternalPlacementTestInput): Promise<ExternalTestCreateResponse>;
|
|
16
16
|
createExternalTestOut(input: CreateExternalTestOutInput): Promise<ExternalTestCreateResponse>;
|
|
17
|
-
createInternalTest(input: CreateInternalTestInput): Promise<
|
|
17
|
+
createInternalTest(input: CreateInternalTestInput): Promise<InternalTestCreateResponse>;
|
|
18
18
|
createNewAttempt(input: CreateNewAttemptInput): Promise<CreateAttemptResponse>;
|
|
19
19
|
finalStudentAssessmentResponse(input: FinalStudentAssessmentResponseInput): Promise<FinalizeAssessmentResponse>;
|
|
20
20
|
getAssessmentProgress(params: GetAssessmentProgressParams): Promise<GetAssessmentProgressResponse>;
|
|
21
21
|
getAttempts(params: GetAttemptsParams): Promise<GetAttemptsResponse>;
|
|
22
22
|
getNextQuestion(params: GetNextQuestionParams): Promise<GetNextQuestionResponse>;
|
|
23
23
|
importExternalTestAssignmentResults(params: ImportExternalTestAssignmentResultsParams): Promise<ImportExternalResultsResponse>;
|
|
24
|
-
makeExternalTestAssignment(input: MakeExternalTestAssignmentInput): Promise<
|
|
24
|
+
makeExternalTestAssignment(input: MakeExternalTestAssignmentInput): Promise<MakeExternalTestAssignmentResponse>;
|
|
25
25
|
resetAttempt(input: ResetAttemptInput): Promise<ResetAttemptResponse>;
|
|
26
26
|
testOut(params: TestOutParams): Promise<TestOutResponse>;
|
|
27
27
|
updateStudentQuestionResponse(input: UpdateStudentQuestionResponseInput): Promise<UpdateStudentQuestionResponseResult>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assessment.d.ts","sourceRoot":"","sources":["../../src/resources/assessment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,OAAO,KAAK,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,0BAA0B,EAC1B,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,EACpB,eAAe,EACf,mCAAmC,EACnC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,KAAK,EACX,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,mCAAmC,EACnC,2BAA2B,EAC3B,iBAAiB,EACjB,qBAAqB,EACrB,yCAAyC,EACzC,+BAA+B,EAC/B,iBAAiB,EACjB,aAAa,EACb,kCAAkC,EAClC,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEtD;;GAEG;AACH,qBAAa,kBAAkB;IAClB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE,2BAA2B,CAC1B,KAAK,EAAE,gCAAgC,GACrC,OAAO,CAAC,0BAA0B,CAAC,CAUrC;IAED,qBAAqB,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAM5F;IAED,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAMtF;IAED,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAM7E;IAED,8BAA8B,CAC7B,KAAK,EAAE,mCAAmC,GACxC,OAAO,CAAC,0BAA0B,CAAC,CAarC;IAED,qBAAqB,CACpB,MAAM,EAAE,2BAA2B,GACjC,OAAO,CAAC,6BAA6B,CAAC,CASxC;IAED,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAGnE;IAED,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAG/E;IAED,mCAAmC,CAClC,MAAM,EAAE,yCAAyC,GAC/C,OAAO,CAAC,6BAA6B,CAAC,CAUxC;IAED,0BAA0B,CACzB,KAAK,EAAE,+BAA+B,GACpC,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"assessment.d.ts","sourceRoot":"","sources":["../../src/resources/assessment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,OAAO,KAAK,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,0BAA0B,EAC1B,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EACvB,6BAA6B,EAC7B,0BAA0B,EAC1B,kCAAkC,EAClC,oBAAoB,EACpB,eAAe,EACf,mCAAmC,EACnC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,KAAK,EACX,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,mCAAmC,EACnC,2BAA2B,EAC3B,iBAAiB,EACjB,qBAAqB,EACrB,yCAAyC,EACzC,+BAA+B,EAC/B,iBAAiB,EACjB,aAAa,EACb,kCAAkC,EAClC,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEtD;;GAEG;AACH,qBAAa,kBAAkB;IAClB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,sBAAsB,EAAI;IAElE,2BAA2B,CAC1B,KAAK,EAAE,gCAAgC,GACrC,OAAO,CAAC,0BAA0B,CAAC,CAUrC;IAED,qBAAqB,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAM5F;IAED,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAMtF;IAED,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAM7E;IAED,8BAA8B,CAC7B,KAAK,EAAE,mCAAmC,GACxC,OAAO,CAAC,0BAA0B,CAAC,CAarC;IAED,qBAAqB,CACpB,MAAM,EAAE,2BAA2B,GACjC,OAAO,CAAC,6BAA6B,CAAC,CASxC;IAED,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAGnE;IAED,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAG/E;IAED,mCAAmC,CAClC,MAAM,EAAE,yCAAyC,GAC/C,OAAO,CAAC,6BAA6B,CAAC,CAUxC;IAED,0BAA0B,CACzB,KAAK,EAAE,+BAA+B,GACpC,OAAO,CAAC,kCAAkC,CAAC,CAU7C;IAED,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAMpE;IAED,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAGvD;IAED,6BAA6B,CAC5B,KAAK,EAAE,kCAAkC,GACvC,OAAO,CAAC,mCAAmC,CAAC,CAa9C;CACD"}
|