@brighterly/lib-core-types 0.18.12 → 0.19.0

package/dist/student-assessment/enums.d.ts

@@ -0,0 +1,9 @@
+export declare enum AssessmentStatus {
+    Pending = "PENDING",
+    Incomplete = "INCOMPLETE",
+    NeedGrading = "NEED_GRADING",
+    Completed = "COMPLETED"
+}
+export declare enum AssessmentType {
+    Baseline = "BASELINE"
+}

package/dist/student-assessment/enums.js

@@ -0,0 +1,11 @@
+export var AssessmentStatus;
+(function (AssessmentStatus) {
+    AssessmentStatus["Pending"] = "PENDING";
+    AssessmentStatus["Incomplete"] = "INCOMPLETE";
+    AssessmentStatus["NeedGrading"] = "NEED_GRADING";
+    AssessmentStatus["Completed"] = "COMPLETED";
+})(AssessmentStatus || (AssessmentStatus = {}));
+export var AssessmentType;
+(function (AssessmentType) {
+    AssessmentType["Baseline"] = "BASELINE";
+})(AssessmentType || (AssessmentType = {}));

package/dist/student-assessment/interfaces.d.ts

@@ -0,0 +1,136 @@
+import type { AssessmentStatus, AssessmentType } from './enums';
+import type { ContentBlock, DisciplineCode, Interaction, OutcomeKind, ResponseKind, RubricScoreMap } from './types';
+export interface AssetRef {
+    url: string;
+}
+export interface TextBlock {
+    type: 'text';
+    value: string;
+    audioUrl?: string;
+}
+export interface ImageBlock {
+    type: 'image';
+    asset: AssetRef;
+    alt: string;
+}
+export interface AudioBlock {
+    type: 'audio';
+    asset: AssetRef;
+}
+export interface Choice {
+    id: string;
+    text: string;
+    correct: boolean;
+}
+export interface MultipleChoice {
+    type: 'multiple_choice';
+    mode: 'single' | 'multi';
+    options: Choice[];
+}
+export interface Blank {
+    accepted: string[];
+    caseSensitive?: boolean;
+    acceptSpellingErrors?: boolean;
+}
+export interface FillInBlanks {
+    type: 'fill_in_blanks';
+    text: string;
+    blanks: Blank[];
+}
+export interface DragTheWords {
+    type: 'drag_the_words';
+    text: string;
+    distractors?: string[];
+}
+export interface OpenEnded {
+    type: 'open_ended';
+}
+export interface WhiteboardStroke {
+    points: {
+        x: number;
+        y: number;
+    }[];
+    color: string;
+    width: number;
+}
+export interface Whiteboard {
+    type: 'whiteboard';
+    backgroundAsset?: AssetRef;
+    backgroundAlt?: string;
+}
+export interface AudioResponse {
+    type: 'audio_response';
+}
+export interface OpenEndedValue {
+    text: string;
+}
+export interface WhiteboardValue {
+    strokes: WhiteboardStroke[];
+}
+export interface AudioResponseValue {
+    asset: AssetRef;
+}
+export interface Standard {
+    code: string;
+    label: string;
+}
+export interface Rubric {
+    id: string;
+    name: string;
+    levels: {
+        score: number;
+        label: string;
+    }[];
+}
+export interface Activity {
+    id: string;
+    content: ContentBlock[];
+    interaction?: Interaction;
+    idkEnabled?: boolean;
+    points?: number;
+    standard?: Standard;
+    rubrics?: string[];
+}
+export interface Assessment {
+    id: string;
+    schemaVersion: number;
+    title: string;
+    disciplineCode: DisciplineCode;
+    grade: string;
+    activities: Activity[];
+}
+export interface Response {
+    activityId: string;
+    kind: ResponseKind;
+    value?: unknown;
+}
+export interface Outcome {
+    activityId: string;
+    outcome: OutcomeKind;
+    score: number;
+    max: number;
+}
+export interface AssessmentDocument {
+    definition: Assessment;
+    responses: Response[];
+    outcomes?: Outcome[];
+    rubrics?: Record<string, Rubric>;
+    rubricScores?: RubricScoreMap;
+}
+export interface StudentAssessmentDetail {
+    id: number;
+    type: AssessmentType;
+    type_label: string;
+    discipline: string;
+    status: AssessmentStatus;
+    status_label: string;
+    score: number | null;
+    submitted_at: string | null;
+    link: string | null;
+    data: AssessmentDocument | null;
+}
+export interface StudentAssessmentUpdatePayload {
+    data: AssessmentDocument;
+    score: number | null;
+    status: AssessmentStatus.NeedGrading | AssessmentStatus.Completed;
+}

package/dist/student-assessment/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/student-assessment/types.d.ts

@@ -0,0 +1,11 @@
+import type { AudioBlock, AudioResponse, DragTheWords, FillInBlanks, ImageBlock, MultipleChoice, OpenEnded, TextBlock, Whiteboard } from './interfaces';
+export type DisciplineCode = 'MATH' | 'ELA';
+export type ContentBlock = TextBlock | ImageBlock | AudioBlock;
+export type Interaction = MultipleChoice | FillInBlanks | DragTheWords | OpenEnded | Whiteboard | AudioResponse;
+export type InteractionType = Interaction['type'];
+export type ResponseKind = 'answered' | 'idk' | 'blank';
+export type OutcomeKind = 'correct' | 'incorrect' | 'no_evidence' | 'needs_review' | 'blank' | 'graded';
+export type MultipleChoiceValue = string[];
+export type FillInBlanksValue = string[];
+export type DragTheWordsValue = string[];
+export type RubricScoreMap = Record<string, Record<string, number>>;

package/dist/student-assessment/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brighterly/lib-core-types",
-  "version": "0.18.12",
+  "version": "0.19.0",
   "description": "Official Brighterly lib-core-types",
   "type": "module",
   "main": "./dist/index.js",
@@ -68,6 +68,16 @@
       "types": "./dist/assessment/enums.d.ts",
       "import": "./dist/assessment/enums.js"
     },
+    "./student-assessment/interfaces": {
+      "types": "./dist/student-assessment/interfaces.d.ts"
+    },
+    "./student-assessment/types": {
+      "types": "./dist/student-assessment/types.d.ts"
+    },
+    "./student-assessment/enums": {
+      "types": "./dist/student-assessment/enums.d.ts",
+      "import": "./dist/student-assessment/enums.js"
+    },
     "./booking/interfaces": {
       "types": "./dist/booking/interfaces.d.ts"
     },