@magmamath/students-features 1.0.1 → 1.0.2-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magmamath/students-features",
-  "version": "1.0.1",
+  "version": "1.0.2-rc.10",
   "description": "Magmamath features library",
   "source": "src/index.ts",
   "main": "src/index.ts",

package/src/features/chatbot/helpers.ts

@@ -103,6 +103,7 @@ export function prepareChatRequestPayload(
       ...(imageCdnId && { imageCdnId }),
       ...(imageAltText && { altText: imageAltText }),
       ...(!!problemStandards?.length && { problemStandards }),
+      ...(!!answerOptions?.length && { answerOptions }),
     },
   }
 }

package/src/features/chatbot/model/ChatBotThreadManager.ts

@@ -63,8 +63,21 @@ export class ChatBotThreadManager {
       const content = await this.drawBoardAdapter.getContent()
       if (!content) return threadItem
       threadItem.setValidationKey(content.validationKey)
-      if (content.text) return threadItem.setText(content.text)
-      if (content.strokes?.length) return threadItem.setStrokes(content.strokes)
+      threadItem.setHintNumber(content.hintNumber)
+      threadItem.setStudentInput(content.studentInput)
+
+      if (content.strokes?.length) {
+        threadItem.setStrokes(content.strokes)
+      }
+      if (content.spreadSheetContent?.length) {
+        threadItem.setSpreadSheetContent(content.spreadSheetContent)
+      }
+      if (content.equationWriterContent?.length) {
+        threadItem.setEquationWriterContent(content.equationWriterContent)
+      }
+      if (content.drawBoardImage) {
+        threadItem.setDrawBoardImage(content.drawBoardImage)
+      }
     } catch {}
 
     return threadItem

package/src/features/chatbot/model/ThreadItem.ts

@@ -1,24 +1,44 @@
-import { FullStrokeData, IThreadItem } from '../types/units.types'
+import {
+  EquationItem,
+  FullStrokeData,
+  IThreadItem,
+  SpreadsheetItem,
+} from '../types/units.types'
 import { generateRandomId } from '../../../lib/helpers/helpers'
 
 type ThreadItemProps = {
   strokes?: FullStrokeData[]
-  text?: string
   key: string
+  spreadSheetContent?: SpreadsheetItem[]
+  equationWriterContent?: EquationItem[]
+  drawBoardImage?: string
+  hintNumber?: number
+  studentInput?: string
 }
 
+const DEFAULT_HINT_NUMBER = 0
+const DEFAULT_STUDENT_INPUT = 'none'
+
 export class ThreadItem implements IThreadItem {
   public readonly id = generateRandomId()
   public readonly history: string[] = []
   public strokesValidationKey: string | null = null
   public strokes: FullStrokeData[] | null
-  public text: string | null = null
   public errorStrokesIds: string[] | null = null
+  public spreadSheetContent?: SpreadsheetItem[]
+  public equationWriterContent?: EquationItem[]
+  public drawBoardImage?: string
+  public hintNumber: number
+  public studentInput: string
 
   public constructor(props?: ThreadItemProps | null) {
     this.strokes = props?.strokes ?? null
-    this.text = props?.text ?? null
     this.strokesValidationKey = props?.key ?? null
+    this.spreadSheetContent = props?.spreadSheetContent
+    this.equationWriterContent = props?.equationWriterContent
+    this.drawBoardImage = props?.drawBoardImage
+    this.hintNumber = props?.hintNumber ?? DEFAULT_HINT_NUMBER
+    this.studentInput = props?.studentInput ?? DEFAULT_STUDENT_INPUT
   }
 
   public setStrokes(strokes: FullStrokeData[]) {
@@ -26,11 +46,6 @@ export class ThreadItem implements IThreadItem {
     return this
   }
 
-  public setText(text: string) {
-    this.text = text
-    return this
-  }
-
   public setValidationKey(key: string) {
     this.strokesValidationKey = key
     return this
@@ -41,19 +56,57 @@ export class ThreadItem implements IThreadItem {
     return this
   }
 
+  public setSpreadSheetContent(content: SpreadsheetItem[]) {
+    this.spreadSheetContent = content
+    return this
+  }
+
+  public setEquationWriterContent(content: EquationItem[]) {
+    this.equationWriterContent = content
+    return this
+  }
+
+  public setDrawBoardImage(image: string) {
+    this.drawBoardImage = image
+    return this
+  }
+
+  public setHintNumber(hintNumber: number) {
+    this.hintNumber = hintNumber
+    return this
+  }
+
+  public setStudentInput(studentInput: string) {
+    this.studentInput = studentInput
+    return this
+  }
+
+  private getBaseHintProps() {
+    return {
+      hintNumber: this.hintNumber,
+      studentInput: this.studentInput,
+      ...(this.drawBoardImage && { drawBoardImage: this.drawBoardImage }),
+    }
+  }
+
   public getNextHintProps() {
+    const baseProps = this.getBaseHintProps()
     if (this.history.length) {
-      return {
-        previousHint: this.history[this.history.length - 1],
-      }
+      return { previousHint: this.history[this.history.length - 1], ...baseProps }
     }
 
-    if (this.text) {
-      return { drawBoardText: this.text }
+    if (this.strokes?.length) {
+      return { stroke: this.strokes, ...baseProps }
     }
 
-    if (this.strokes && this.strokes.length > 0) {
-      return { stroke: this.strokes }
+    if (this.spreadSheetContent?.length) {
+      return { spreadSheetContent: this.spreadSheetContent, ...baseProps }
     }
+
+    if (this.equationWriterContent?.length) {
+      return { equationWriterContent: this.equationWriterContent, ...baseProps }
+    }
+
+    return baseProps
   }
 }

package/src/features/chatbot/types/api.types.ts

@@ -1,4 +1,6 @@
-import { ChatAnswer, FullStrokeData, Stroke } from './units.types'
+import { ChatAnswer, FullStrokeData, Stroke,   EquationItem,
+  SpreadsheetItem,
+} from './units.types'
 import { ProblemStandard } from './model.types'
 
 export type GetAlternativesPayload = {
@@ -107,6 +109,12 @@ export type ChatHintPayload = {
   imageAltText?: string
   imageCdnId?: string
   drawBoardText?: string
+  spreadSheetContent?: SpreadsheetItem[]
+  equationWriterContent?: EquationItem[]
+  drawBoardImage?: string
+  hintNumber: number
+  studentInput: string
+  answerOptions?: string[]
 }
 
 export type ChatHintResponse = {

package/src/features/chatbot/types/model.types.ts

@@ -16,7 +16,14 @@ import {
   SendMessageResponse,
 } from './api.types'
 import { ExtendWithOptional } from '../../../lib/helpers/types'
-import { ChatAnswer, ChatItem, ConversationMessage, FullStrokeData } from './units.types'
+import {
+  EquationItem,
+  ChatAnswer,
+  ChatItem,
+  ConversationMessage,
+  FullStrokeData,
+  SpreadsheetItem,
+} from './units.types'
 import { WithAbortSignal } from '../../../lib/types/requests'
 import { RequestOptionalConfig } from '../../../lib/effector/createControllerEffect'
 
@@ -114,8 +121,12 @@ type GetVisibleStrokesResponse = {
 
 type GetBoardContentResponse = {
   strokes?: FullStrokeData[]
-  text?: string
   validationKey: string
+  spreadSheetContent?: SpreadsheetItem[]
+  equationWriterContent?: EquationItem[]
+  drawBoardImage?: string
+  hintNumber: number
+  studentInput: string
 }
 
 export type IChatDrawBoardAdapter = {

package/src/features/chatbot/types/units.types.ts

@@ -2,16 +2,36 @@ export type Stroke = {
   x: number[]
   y: number[]
 }
+
 export type FullStrokeData = Stroke & {
   id: string
 }
 
+export type EquationItem = {
+  id: string
+  value?: string
+}
+
+export type SpreadsheetItem = {
+  id: string
+  value?: string
+  point: {
+    x: number
+    y: number
+  }
+}
+
 export type IThreadItem = {
   id: string
   strokesValidationKey: string | null
   strokes: FullStrokeData[] | null
   history: string[]
   errorStrokesIds: string[] | null
+  spreadSheetContent?: SpreadsheetItem[]
+  equationWriterContent?: EquationItem[]
+  drawBoardImage?: string
+  hintNumber: number
+  studentInput: string
 }
 
 export type ChatAnswer = {

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig",
+  "exclude": ["example", "dist"]
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@magmamath/students-features": ["./src/index"]
+    },
+    "target": "esnext",
+    "baseUrl": "./",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "declaration": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react",
+    "experimentalDecorators": true
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "example"
+  ]
+}