@pocketprep/types 1.19.18 → 1.19.20

package/API/Bundle.d.ts

@@ -25,8 +25,9 @@ export interface ExamMetadata extends BaseResource {
     compositeKey: string
     description?: string
     isFree: boolean
-    /** Ids of the MockExams associated with this exam. */
+    /** @deprecated Use mockExamIds instead. */
     mockExams: string[]
+    mockExamIds: string[]
     sunsetAt?: string
     minorVersionMessaging?: {
         type: 'newQuestions' | 'newMockExams'
@@ -47,8 +48,9 @@ export interface ExamMetadata extends BaseResource {
 
 export interface Bundle extends BaseResource {
     name: string
-    /** Ids of the ExamMetadata records in this bundle. */
+    /** @deprecated Use examMetadataIds instead. */
     exams: string[]
+    examMetadataIds: string[]
     ios?: {
         currentVersion: string
         minVersion: string
@@ -77,6 +79,8 @@ export interface FetchBundlesParams {
 
 export interface FetchBundlesResponse {
     bundles: Bundle[]
+    /** @deprecated Use examMetadatas instead. */
     exams: ExamMetadata[]
+    examMetadatas: ExamMetadata[]
     mockExams: MockExam[]
 }

package/API/KeywordDefinition.d.ts

@@ -4,8 +4,9 @@ export interface KeywordDefinition extends BaseResource {
     keyword: string
     definition: string
     serial: string
-    /** ExamMetadata id (pointer flattened). */
+    /** @deprecated Use examMetadataId instead. */
     examMetadata?: string
+    examMetadataId?: string
 }
 
 export interface SearchKeywordDefinitionsParams {

package/API/Question.d.ts

@@ -20,8 +20,9 @@ export interface QuestionImage {
 
 export interface Question extends BaseResource {
     prompt: string
-    /** Subject id (pointer flattened). */
+    /** @deprecated Use subjectId instead. */
     subject: string
+    subjectId: string
     subtopicId?: string
     bloomTaxonomyLevel?: BloomTaxonomyLevel
     choices: QuestionChoice[]
@@ -31,8 +32,9 @@ export interface Question extends BaseResource {
     explanationImage?: QuestionImage
     references?: string[]
     serial: string
-    /** ExamMetadata id (pointer flattened). */
+    /** @deprecated Use examMetadataId instead. */
     examMetadata: string
+    examMetadataId: string
     compositeKey: string
     type:
         | 'Multiple Choice'
@@ -46,8 +48,9 @@ export interface Question extends BaseResource {
     isArchived: boolean
     isFree: boolean
     isMockQuestion: boolean
-    /** QuestionScenario id (pointer flattened, optional). */
+    /** @deprecated Use questionScenarioId instead. */
     questionScenario?: string
+    questionScenarioId?: string
     matrixLabels?: IMatrixLabels
     matrixChoiceLayout?: string[][]
     passageLabel?: TPassageLabel
@@ -57,8 +60,9 @@ export interface Question extends BaseResource {
 export interface Subject extends BaseResource {
     name: string
     isArchived: boolean
-    /** ExamMetadata id (pointer flattened). */
+    /** @deprecated Use examMetadataId instead. */
     examMetadata: string
+    examMetadataId: string
     questionCount?: number
     subtopics?: Subtopic[]
 }

package/API/Session.d.ts

@@ -3,7 +3,8 @@ import { BaseResource } from './BaseResource'
 export interface Session extends BaseResource {
     sessionToken: string
     expiresAt: string
-    /** User id (pointer flattened). */
+    /** @deprecated Use userId instead. */
     user: string
+    userId: string
     createdWith?: { action: string; authProvider: string }
 }

package/API/User.d.ts

@@ -19,8 +19,9 @@ export interface User extends BaseResource {
     company?: string
     currentApp?: string
     currentExamGuid?: string
-    /** UserExamMetadata id (pointer flattened — UEM itself is no longer hydrated). */
+    /** @deprecated Use currentUserExamMetadataId instead. */
     currentUserExamMetadata?: string
+    currentUserExamMetadataId?: string
     lastActiveAt?: string
     onboardingCompleted?: boolean
     quizSettings?: QuizSettings

package/CMS/Class.d.ts

@@ -364,6 +364,31 @@ export type ExamExportMockExam = {
     meLength: number
 } & ExamExportQuestionTypeCounts
 
+export type ExportDiff = {
+    jobsCount: number
+    subjectsCount: {
+        oldCount: number
+        newCount: number
+    }
+    subtopicsCount: {
+        oldCount: number
+        newCount: number
+    }
+    sqbCount: {
+        oldCount: number
+        newCount: number
+    }
+    mockExamsCount: {
+        oldCount: number
+        newCount: number
+    }
+    mockExams?: {
+        name: string
+        oldValue: number | 'isDisabled'
+        newValue: number | 'isDisabled'
+    }[]
+}
+
 export type ExamExportLog = Parse.Object<{
     scenarioCount: number
     examMetadataId: string
@@ -373,10 +398,22 @@ export type ExamExportLog = Parse.Object<{
     type: 'patch' | 'minor' | 'major'
     user: User | Parse.Pointer
     mockExams: ExamExportMockExam[]
+    sunsetAt?: Date
+    exportDiff?: ExportDiff
 } & ExamExportQuestionTypeCounts>
 
 export type ExamExportLogJSON = ReturnType<ExamExportLog['toJSON']>
 
+export type HistoricalChange = {
+    [K in keyof ExamContentPlanJSON]-?: {
+        changedField: K
+        oldValue: ExamContentPlanJSON[K]
+        newValue: ExamContentPlanJSON[K]
+        date: Date
+        authorUserId: string,
+    }
+}[keyof ExamContentPlanJSON]
+
 export type ExamContentPlan = Parse.Object<{
     examGuid: string
     keywordStyling?: 'uppercase' | 'bold' | 'uppercase/bold' | 'none'
@@ -398,6 +435,7 @@ export type ExamContentPlan = Parse.Object<{
     newExamLinks?: string
     addingReferences?: boolean
     removingReferences?: boolean
+    historicalChanges?: HistoricalChange[],
 }>
 
 export type ExamContentPlanJSON = ReturnType<ExamContentPlan['toJSON']>
@@ -408,4 +446,17 @@ export type Comment = Parse.Object<{
     body: string
 }>
 
-export type CommentJSON = ReturnType<Comment['toJSON']>
+export type CommentJSON = ReturnType<Comment['toJSON']>
+
+export type CompletedJobLog = Parse.Object<{
+    objective: string
+    questionBank: string
+    writer?: User
+    editor?: User
+    startDate: Date
+    dueDate?: Date
+    summary: string
+    questionTypeCounts: ExamExportQuestionTypeCounts
+}>
+
+export type CompletedJobLogJSON = ReturnType<CompletedJobLog['toJSON']>

package/CMS/Cloud.d.ts

@@ -13,6 +13,7 @@ import {
     ExamExportLogJSON,
     ExamContentPlanJSON,
     CommentJSON,
+    CompletedJobLogJSON,
 } from './Class'
 import {
     GlobalQuestionMetricJSON,
@@ -407,9 +408,11 @@ export type ExamContentPlanPayload = Omit<ExamContentPlanJSON, 'objectId' | 'cre
 
 export type upsertExamContentPlan = (params: ExamContentPlanPayload) => ExamContentPlanJSON
 
-export type fetchExamContentPlans = () => ExamContentPlanJSON[]
+export type fetchExamContentPlans = (params?: { includeHistoricalChanges?: boolean }) => ExamContentPlanJSON[]
 
-export type fetchExamContentPlanForExamGuid = (params: { examGuid: string }) => ExamContentPlanJSON
+export type fetchExamContentPlanForExamGuid = (
+    params: { examGuid: string, includeHistoricalChanges?: boolean }
+) => ExamContentPlanJSON
 
 export type fetchLatestMinorOrMajorExamExportLogIsoDates = () => { [examMetadataId: string]: string }
 
@@ -421,4 +424,6 @@ export type fetchCommentsByExamGuid = (params: { examGuid: string }) => CommentJ
 
 export type updateComment = (params: { objectId: string; body: string }) => CommentJSON
 
-export type deleteComment = (params: { objectId: string }) => true
+export type deleteComment = (params: { objectId: string }) => true
+
+export type fetchCompletedJobLogsForExamGuid = (params: { examGuid: string }) => CompletedJobLogJSON[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocketprep/types",
-  "version": "1.19.18",
+  "version": "1.19.20",
   "description": "Pocket Prep type declarations",
   "repository": {
     "type": "git",