@pocketprep/types 1.17.0 → 1.18.1

package/API/BaseResource.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Common base for every API response resource.
+ *
+ * Responses are Parse-free and use ISO-8601 timestamp strings. Pointer
+ * fields hold raw id strings (or string arrays); the Nest repository layer
+ * translates Mongo storage shape into this contract at the boundary.
+ */
+export interface BaseResource {
+    id: string
+    createdAt: string
+    updatedAt: string
+}

package/API/Bundle.d.ts

@@ -0,0 +1,82 @@
+import { BaseResource } from './BaseResource'
+
+export interface MockExam extends BaseResource {
+    name: string
+    description?: string
+    enabled: boolean
+    durationSeconds: number
+    questionSerials: string[]
+}
+
+export interface ExamMetadata extends BaseResource {
+    hideReferences: boolean
+    examGuid: string
+    archivedCount: number
+    freeCount?: number
+    totalCount?: number
+    nativeAppName: string
+    releaseInfo?: {
+        name: string
+        description: string
+        message: string
+    }
+    descriptiveName: string
+    version: string
+    compositeKey: string
+    description?: string
+    isFree: boolean
+    /** Ids of the MockExams associated with this exam. */
+    mockExams: string[]
+    sunsetAt?: string
+    minorVersionMessaging?: {
+        type: 'newQuestions' | 'newMockExams'
+        count: number
+    }
+    appId?: string
+    knowledgeAreas?: {
+        [key: string]: {
+            name: string
+            count: number
+            specialCount: number
+        }
+    }
+    itemCount?: number
+    classicQuestions?: number
+    specialQuestions?: number
+}
+
+export interface Bundle extends BaseResource {
+    name: string
+    /** Ids of the ExamMetadata records in this bundle. */
+    exams: string[]
+    ios?: {
+        currentVersion: string
+        minVersion: string
+        appStoreId: string
+        appStoreURI: string
+        appStoreIds: string[]
+    }
+    android?: {
+        currentVersion: string
+        minVersion: string
+        appStoreId: string
+        appStoreURI: string
+        appStoreIds: string[]
+    }
+    isDisabled: boolean
+    seatPricingModel?: {
+        costPerSeat: number
+        customExamPrices?: { [examGuid: string]: number }
+    }
+}
+
+export interface FetchBundlesParams {
+    platform?: 'iOS' | 'Android'
+    appStoreId?: string
+}
+
+export interface FetchBundlesResponse {
+    bundles: Bundle[]
+    exams: ExamMetadata[]
+    mockExams: MockExam[]
+}

package/API/KeywordDefinition.d.ts

@@ -0,0 +1,18 @@
+import { BaseResource } from './BaseResource'
+
+export interface KeywordDefinition extends BaseResource {
+    keyword: string
+    definition: string
+    serial: string
+    /** ExamMetadata id (pointer flattened). */
+    examMetadata?: string
+}
+
+export interface SearchKeywordDefinitionsParams {
+    examMetadataId: string
+    serials: string[]
+}
+
+export interface SearchKeywordDefinitionsResponse {
+    keywords: KeywordDefinition[]
+}

package/API/LevelUp.d.ts

@@ -0,0 +1,7 @@
+export interface CheckLevelUpEligibilityParams {
+    examGuid: string
+}
+
+export interface CheckLevelUpEligibilityResponse {
+    eligible: boolean
+}

package/API/Question.d.ts

@@ -0,0 +1,74 @@
+import { BloomTaxonomyLevel, Subtopic } from '../Study/Class'
+import { IMatrixLabels, TPassageLabel } from '../CMS/Class'
+
+import { BaseResource } from './BaseResource'
+
+/** Shape of an individual choice on a Question. Matches Parse's stored shape. */
+export interface QuestionChoice {
+    text?: string
+    isCorrect: boolean
+    id: string
+    labelIndex?: number
+}
+
+/** Image-with-alt structure used by passage and explanation. */
+export interface QuestionImage {
+    url: string
+    altText: string
+    longAltText?: string
+}
+
+export interface Question extends BaseResource {
+    prompt: string
+    /** Subject id (pointer flattened). */
+    subject: string
+    subtopicId?: string
+    bloomTaxonomyLevel?: BloomTaxonomyLevel
+    choices: QuestionChoice[]
+    passage?: string
+    passageImage?: QuestionImage
+    explanation?: string
+    explanationImage?: QuestionImage
+    references?: string[]
+    serial: string
+    /** ExamMetadata id (pointer flattened). */
+    examMetadata: string
+    compositeKey: string
+    type:
+        | 'Multiple Choice'
+        | 'Multiple Correct Response'
+        | 'True/False'
+        | 'Matrix Checkbox'
+        | 'Matrix Radio Button'
+        | 'Multi-Part Multiple Choice'
+        | 'Build List'
+    addedDate: string
+    isArchived: boolean
+    isFree: boolean
+    isMockQuestion: boolean
+    /** QuestionScenario id (pointer flattened, optional). */
+    questionScenario?: string
+    matrixLabels?: IMatrixLabels
+    matrixChoiceLayout?: string[][]
+    passageLabel?: TPassageLabel
+    mpmcLabels?: string[]
+}
+
+export interface Subject extends BaseResource {
+    name: string
+    isArchived: boolean
+    /** ExamMetadata id (pointer flattened). */
+    examMetadata: string
+    questionCount?: number
+    subtopics?: Subtopic[]
+}
+
+export interface FetchQotdParams {
+    daysSinceEpoch: number
+    count?: number
+}
+
+export interface FetchQotdResponse {
+    questions: Question[]
+    subjects: Subject[]
+}

package/API/Session.d.ts

@@ -0,0 +1,9 @@
+import { BaseResource } from './BaseResource'
+
+export interface Session extends BaseResource {
+    sessionToken: string
+    expiresAt: string
+    /** User id (pointer flattened). */
+    user: string
+    createdWith?: { action: string; authProvider: string }
+}

package/API/User.d.ts

@@ -0,0 +1,30 @@
+import { BaseResource } from './BaseResource'
+
+export interface QuizSettings {
+    showCheckAnswerButton?: boolean
+    showAnswersAtEnd?: boolean
+    enableKeyboardShortcuts?: boolean
+}
+
+/**
+ * User response shape. Sensitive columns (`password`, `_hashed_password`,
+ * `stripeCustomerId`) are stripped at the flatten boundary so they never
+ * reach this contract.
+ */
+export interface User extends BaseResource {
+    email: string
+    firstName?: string
+    lastName?: string
+    username?: string
+    company?: string
+    currentApp?: string
+    currentExamGuid?: string
+    /** UserExamMetadata id (pointer flattened — UEM itself is no longer hydrated). */
+    currentUserExamMetadata?: string
+    lastActiveAt?: string
+    onboardingCompleted?: boolean
+    quizSettings?: QuizSettings
+    title?: string
+    version?: string
+    webConfig?: Record<string, unknown>
+}

package/API/index.d.ts

@@ -0,0 +1,7 @@
+export * from './BaseResource'
+export * from './Bundle'
+export * from './Question'
+export * from './KeywordDefinition'
+export * from './Session'
+export * from './User'
+export * from './LevelUp'

package/index.d.ts

@@ -4,6 +4,7 @@ import * as CMS from './CMS'
 import * as Teach from './Teach'
 import * as Support from './Support'
 import * as AI from './AI'
+import * as API from './API'
 
 export {
     Study,
@@ -11,6 +12,7 @@ export {
     Teach,
     Support,
     AI,
+    API,
 }
 
 export type Payload<T extends Parse.Object> = T extends Parse.Object<infer R>

package/package.json

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