@magmamath/students-features 1.3.9 → 1.3.10-rc.1

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

@@ -152,7 +152,6 @@ export type ChatbotContext = {
   problemStandards?: ProblemStandard[]
   assignmentId?: string
   problemId?: string
-  assignmentGrade?: number
 }
 
 export type ReinitConversationProps = {

package/src/features/uiMode/getUIMode.ts

@@ -0,0 +1,28 @@
+import { GetUIModeProps, UIModeResult } from './uiMode.types'
+import { getAnswerAreaMode, getToolbarMode, isSimpleMode } from './uiMode.helpers'
+import { UIMode } from './uiMode.constants'
+
+export const getUIMode = ({
+  user,
+  practice,
+  assignment,
+  locale,
+  problem,
+}: GetUIModeProps): UIModeResult => {
+  const grade = assignment.grade ?? practice.grade
+  const isSimple = isSimpleMode({ user, practice, assignment })
+
+  if (!isSimple) {
+    return {
+      general: UIMode.REGULAR,
+      toolbar: getToolbarMode({ isSimpleModeGrade: false, grade, locale }),
+      answerArea: UIMode.REGULAR,
+    }
+  }
+
+  return {
+    general: UIMode.SIMPLE,
+    toolbar: getToolbarMode({ isSimpleModeGrade: true, grade, locale }),
+    answerArea: getAnswerAreaMode({ practice, problem }),
+  }
+}

package/src/features/uiMode/index.ts

@@ -0,0 +1,2 @@
+export { UIMode } from './uiMode.constants'
+export { getUIMode } from './getUIMode'

package/src/features/uiMode/uiMode.constants.ts

@@ -0,0 +1,7 @@
+export const GRADE_K2 = 2
+export const INVALID_GRADE = -1
+
+export enum UIMode {
+  REGULAR = 'REGULAR',
+  SIMPLE = 'SIMPLE',
+}

package/src/features/uiMode/uiMode.helpers.ts

@@ -0,0 +1,52 @@
+import { UIMode, GRADE_K2, INVALID_GRADE } from './uiMode.constants'
+import {
+  GetAnswerAreaModeProps,
+  GetToolbarModeProps,
+  Grade,
+  IsSimpleModeProps,
+} from './uiMode.types'
+
+import { AnswerType } from '../../types/answerTypes'
+import { MyScriptMathCharacterTypes } from '../../types/characterTypes'
+import { ToolBarVariants } from '@magmamath/react-native-draw-board'
+import { Locale } from '@magmamath/frontend-config'
+
+const isValidGrade = (grade: Grade): grade is number => {
+  return grade !== undefined && grade !== null && grade !== INVALID_GRADE
+}
+
+export const isBelowGradeK2 = (grade: Grade) => {
+  return isValidGrade(grade) && grade >= 0 && grade <= GRADE_K2
+}
+
+export const isSimpleMode = ({ user, practice, assignment }: IsSimpleModeProps) => {
+  if (practice.isEnabled) return isBelowGradeK2(practice.grade)
+  if (!isValidGrade(user.grade)) return isBelowGradeK2(assignment.grade)
+  return isBelowGradeK2(user.grade)
+}
+
+export const getAnswerAreaMode = ({ practice, problem }: GetAnswerAreaModeProps): UIMode => {
+  const isHandwritingNumbersWhole =
+    problem.answerType === AnswerType.HANDWRITING &&
+    problem.characterType === MyScriptMathCharacterTypes.NUMBERS_WHOLE
+
+  if (practice.isEnabled || problem.hasAnswerVariants || isHandwritingNumbersWhole) {
+    return UIMode.SIMPLE
+  }
+
+  return UIMode.REGULAR
+}
+
+export const getToolbarMode = ({
+  isSimpleModeGrade,
+  grade,
+  locale,
+}: GetToolbarModeProps): ToolBarVariants => {
+  const isUSOrCA = locale === Locale.US || locale === Locale.CA
+  const gradeThreshold = isUSOrCA ? 6 : 7
+  const isAdvanced = isValidGrade(grade) && grade >= gradeThreshold
+
+  if (isAdvanced) return ToolBarVariants.ADVANCED
+  if (isSimpleModeGrade) return ToolBarVariants.SIMPLE
+  return ToolBarVariants.COMMON
+}

package/src/features/uiMode/uiMode.types.ts

@@ -0,0 +1,46 @@
+import { Locale } from '@magmamath/frontend-config'
+import { AnswerType } from '../../types/answerTypes'
+import { MyScriptMathCharacterTypes } from '../../types/characterTypes'
+import { UIMode } from './uiMode.constants'
+import { ToolBarVariants } from '@magmamath/react-native-draw-board'
+
+export type Grade = number | null | undefined
+
+export type GetUIModeProps = {
+  locale: Locale
+  user: { grade: Grade }
+  practice: { isEnabled: boolean; grade: Grade }
+  assignment: { grade: Grade }
+  problem: {
+    answerType: AnswerType
+    characterType: MyScriptMathCharacterTypes
+    hasAnswerVariants: boolean
+  }
+}
+
+export type UIModeResult = {
+  general: UIMode
+  toolbar: ToolBarVariants
+  answerArea: UIMode
+}
+
+export type IsSimpleModeProps = {
+  user: { grade: Grade }
+  practice: { isEnabled: boolean; grade: Grade }
+  assignment: { grade: Grade }
+}
+
+export type GetAnswerAreaModeProps = {
+  practice: { isEnabled: boolean }
+  problem: {
+    answerType: AnswerType
+    characterType: MyScriptMathCharacterTypes
+    hasAnswerVariants: boolean
+  }
+}
+
+export type GetToolbarModeProps = {
+  isSimpleModeGrade: boolean
+  grade: Grade
+  locale: Locale
+}

package/src/index.ts

@@ -13,3 +13,4 @@ export * from './features/pmProgress'
 export * from './features/openEnded'
 export * from './shared/icons'
 export * from './features/voice'
+export * from './features/uiMode'

package/src/types/answerTypes.ts

@@ -0,0 +1,7 @@
+export enum AnswerType {
+  HANDWRITING = 0,
+  SINGLE_CHOICE = 1,
+  MULTIPLE_CHOICE = 2,
+  ORDERED_CHOICE = 3,
+  OPEN_ENDED = 11,
+}

package/.claude/settings.local.json

@@ -1,25 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npx tsc:*)",
-      "Bash(find /Users/alesiaskarakhod/Work/students-features -name rn-draw-area -o -name *draw*area*)",
-      "Bash(grep:*)",
-      "Bash(find /Users/alesiaskarakhod/Work/magmamath-tools -type f -name \"*.ts*\" ! -path \"*/node_modules/*\" ! -path \"*/.next/*\" ! -path \"*/dist/*\" -exec grep -l \"convertLatexToBrackets\\\\|convertBracketsToLatex\" {})",
-      "Bash(find /Users/alesiaskarakhod/Work/magmamath-tools -type f \\\\\\(-name *.test.ts* -o -name *.spec.ts* \\\\\\))",
-      "Bash(ls jest.config* vitest.config* tsconfig*)",
-      "Bash(npm ls:*)",
-      "Read(//Users/alesiaskarakhod/node_modules/.bin/**)",
-      "Bash(yarn add:*)",
-      "Bash(npx jest:*)",
-      "Bash(node:*)",
-      "Bash(npx ts-node:*)",
-      "Bash(find /Users/alesiaskarakhod/Work/magmamath-tools/packages -name jest.config.* -o -name *.test.ts -o -name *.test.js -o -name *.spec.ts)",
-      "Bash(find /Users/alesiaskarakhod/Work/magmamath-tools/packages -maxdepth 3 -type f \\\\\\(-name *.test.ts -o -name *.spec.ts -o -name *.test.tsx -o -name *.spec.tsx \\\\\\))",
-      "Bash(find /Users/alesiaskarakhod/Work/magmamath-tools -type f \\\\\\(-name *.test.ts -o -name *.test.tsx -o -name *.spec.ts -o -name *.spec.tsx \\\\\\))",
-      "Bash(yarn test:*)",
-      "Bash(npx vitest:*)",
-      "Bash(npx tsup:*)",
-      "Bash(find /Users/alesiaskarakhod/Work/react-native/node_modules/@magmamath/frontend-config -name *.d.ts -o -name *.js)"
-    ]
-  }
-}

package/.editorconfig

@@ -1,15 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-[*]
-
-indent_style = space
-indent_size = 2
-
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/.eslintignore

@@ -1,2 +0,0 @@
-node_modules/
-./lib/

package/.eslintrc

@@ -1,22 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2020": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:storybook/recommended",
-    "prettier"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "plugins": ["react-refresh"],
-  "rules": {
-    "react-refresh/only-export-components": "warn"
-  }
-}

package/.gitattributes

@@ -1,3 +0,0 @@
-*.pbxproj -text
-# specific for windows script files
-*.bat text eol=crlf

package/.github/actions/setup/action.yml

@@ -1,37 +0,0 @@
-name: Setup
-description: Setup Node.js and install dependencies
-
-inputs:
-  npmrc-auth-token:
-    required: true
-
-runs:
-  using: composite
-  steps:
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version-file: .nvmrc
-
-    - name: Create .npmrc
-      shell: bash
-      run: |
-        echo "registry=https://registry.npmjs.org" > .npmrc
-        echo "//registry.npmjs.org/:_authToken=${{ inputs.npmrc-auth-token }}" >> .npmrc
-
-    - name: Cache dependencies
-      id: yarn-cache
-      uses: actions/cache@v4
-      with:
-        path: |
-          **/node_modules
-          .yarn/install-state.gz
-        key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-${{ hashFiles('**/package.json', '!node_modules/**') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}
-          ${{ runner.os }}-yarn-
-
-    - name: Install dependencies
-      if: steps.yarn-cache.outputs.cache-hit != 'true'
-      run: yarn install --immutable
-      shell: bash

package/.github/workflows/ci.yml

@@ -1,73 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-  merge_group:
-    types:
-      - checks_requested
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          npmrc-auth-token: ${{ secrets.MAGMA_NPMRC_TOKEN }}
-
-      - name: Lint files
-        run: yarn lint
-
-      - name: Typecheck files
-        run: yarn typecheck
-
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          npmrc-auth-token: ${{ secrets.MAGMA_NPMRC_TOKEN }}
-
-      - name: Run unit tests
-        run: yarn test --maxWorkers=2 --coverage
-
-  build-library:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          npmrc-auth-token: ${{ secrets.MAGMA_NPMRC_TOKEN }}
-
-      - name: Build package
-        run: yarn prepare
-
-  build-web:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          npmrc-auth-token: ${{ secrets.MAGMA_NPMRC_TOKEN }}
-
-      - name: Build example for Web
-        run: |
-          yarn example expo export --platform web

package/.gitignore

@@ -1,84 +0,0 @@
-# OSX
-#
-.DS_Store
-
-# XDE
-.expo/
-
-# VSCode
-.vscode/
-jsconfig.json
-
-# Xcode
-#
-build/
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata
-*.xccheckout
-*.moved-aside
-DerivedData
-*.hmap
-*.ipa
-*.xcuserstate
-project.xcworkspace
-
-# Android/IJ
-#
-.classpath
-.cxx
-.gradle
-.idea
-.project
-.settings
-local.properties
-android.iml
-
-# Cocoapods
-#
-example/ios/Pods
-
-# Ruby
-example/vendor/
-
-# node.js
-#
-node_modules/
-npm-debug.log
-yarn-debug.log
-yarn-error.log
-
-# BUCK
-buck-out/
-\.buckd/
-android/app/libs
-android/keystores/debug.keystore
-
-# Yarn
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-
-# Expo
-.expo/
-
-# Turborepo
-.turbo/
-
-# generated by bob
-dist/
-!src/lib/
-
-# React Native Codegen
-ios/generated
-android/generated
-.npmrc

package/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

package/.idea/codeStyles/Project.xml

@@ -1,62 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <option name="LINE_SEPARATOR" value="&#10;" />
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <VueCodeStyleSettings>
-      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
-      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
-    </VueCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="Vue">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/copilot.data.migration.agent.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AgentMigrationStateService">
-    <option name="migrationStatus" value="COMPLETED" />
-  </component>
-</project>

package/.idea/copilot.data.migration.ask.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AskMigrationStateService">
-    <option name="migrationStatus" value="COMPLETED" />
-  </component>
-</project>

package/.idea/copilot.data.migration.ask2agent.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="Ask2AgentMigrationStateService">
-    <option name="migrationStatus" value="COMPLETED" />
-  </component>
-</project>

package/.idea/copilot.data.migration.edit.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="EditMigrationStateService">
-    <option name="migrationStatus" value="COMPLETED" />
-  </component>
-</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,8 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="EditorConfigUnusedDeclaration" enabled="false" level="WARNING" enabled_by_default="false" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="UnusedDefine" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/jsLinters/eslint.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="EslintConfiguration">
-    <option name="fix-on-save" value="true" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/students-features.iml" filepath="$PROJECT_DIR$/.idea/students-features.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/prettier.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-    <option name="myRunOnSave" value="true" />
-  </component>
-</project>

package/.idea/students-features.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>