@pie-element/fraction-model 7.0.4-next.20261011174919 → 7.0.4

package/dist/browser/editor-runtime/controller/index.js

@@ -18,7 +18,7 @@ var t = { model: {
 	a(t) ? r({
 		score: 0,
 		empty: !0
-	}) : n.mode === "evaluate" ? r({ score: i(e, n, t.answers) }) : r({
+	}) : n.mode === "evaluate" ? r({ score: i(e, n, t?.answers) }) : r({
 		score: void 0,
 		completed: void 0
 	});

package/dist/browser/editor-runtime/controller/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../../src/controller/defaults.ts","../../../../src/controller/index.ts"],"sourcesContent":["// @ts-nocheck\n\n// Should be exactly the same as configure/defaults.js\nexport default {\n  model: {\n    correctResponse: [],\n    title: '',\n    prompt: '',\n    modelTypeSelected: 'bar',\n    maxModelSelected: 1,\n    partsPerModel: 5,\n    allowedStudentConfig: false,\n    showGraphLabels: false,\n  },\n};\n","// @ts-nocheck\n\nimport { isEmpty } from '@pie-element/shared-lodash';\nimport defaults from './defaults.js';\n\n/*\n * Function to check the correctness of the response\n * @param {model} model contains the model object\n * @param {answers} answers contains the answers object\n * @param {env} env contains the environment object\n * @returns {string} returns the correctness of the response\n * */\nexport const getResponseCorrectness = (model, answers, env = {}) => {\n  let correct;\n  if (model.allowedStudentConfig) {\n    correct = !!(\n      answers.partsPerModel === model.partsPerModel &&\n      partialFillCheck(answers.response, model.partsPerModel) &&\n      numeratorCheck(model.correctResponse, answers.response)\n    );\n  } else {\n    correct = !!(\n      partialFillCheck(answers.response, model.partsPerModel) && numeratorCheck(model.correctResponse, answers.response)\n    );\n  }\n  return correct ? 'correct' : 'incorrect';\n};\n\n/*\n * Function to get the correctness of the response\n * @param {question} question contains the question object\n * @param {env} env contains the environment object\n * @param {answers} answers contains the answers object\n * @returns {string} returns the correctness\n * */\nconst getCorrectness = (question, env, answers = {}) => {\n  if (env.mode === 'evaluate') {\n    return getResponseCorrectness(question, answers, env);\n  }\n};\n\n/*\n * Function to get the outcome score\n * @param {question} question contains the question object\n * @param {env} env contains the environment object\n * @param {answers} answers contains the answers object\n * @returns {number} returns the score\n * */\nconst getOutComeScore = (question, env, answers = {}) => {\n  const correctness = getCorrectness(question, env, answers);\n  return correctness === 'correct' ? 1 : 0;\n};\n\n// A player sends an untouched item's session as `{ id, element }`, without `answers`.\nconst isUnanswered = (session) => !session || isEmpty(session) || !session.answers;\n\n/*\n * Function to check outcome of the session\n * @param {model} model contains the model object\n * @param {session} session contains the session object\n * @param {env} env contains the environment object\n * @returns {Promise} returns the score\n */\nexport const outcome = (model, session, env) =>\n  new Promise((resolve) => {\n    if (isUnanswered(session)) {\n      resolve({ score: 0, empty: true });\n    } else {\n      if (env.mode !== 'evaluate') {\n        resolve({ score: undefined, completed: undefined });\n      } else {\n        resolve({ score: getOutComeScore(model, env, session.answers) });\n      }\n    }\n  });\n\n/*\n * Function to check if the numerator of the response matches the numerator of the correct response\n * @param {correctResponse} correctResponse contains the correct response object\n * @param {response} response contains the response object\n * @returns {boolean} returns true if the numerators match\n * */\nconst numeratorCheck = (correctResponse, response) => {\n  let correctNumerator = 0;\n  let responseNumerator = 0;\n  for (let i = 0; i < correctResponse.length; i++) {\n    correctNumerator += correctResponse[i].value;\n  }\n  for (let i = 0; i < response.length; i++) {\n    responseNumerator += response[i].value;\n  }\n  return correctNumerator === responseNumerator;\n};\n\n/*\n * Function to check if the response contains more than one partially-filled model\n * @param {response} response contains the response object\n * @param {partsPerModel} partsPerModel contains the number of parts per model\n * */\nconst partialFillCheck = (response, partsPerModel) => {\n  if (response.length > 0) {\n    let partialModelCount = 0;\n    response.forEach((selection) => {\n      if (selection.value !== partsPerModel) {\n        partialModelCount++;\n      }\n    });\n    return partialModelCount <= 1;\n  } else {\n    return false;\n  }\n};\n\n/*\n * Function to create a default model\n * @param {model} model contains the model object\n * */\nexport const createDefaultModel = (model = {}) => ({\n  ...defaults.model,\n  ...model,\n});\n\n/*\n * Return the model object\n * */\nexport const model = (question, session, env) => {\n  return new Promise((resolve) => {\n    session = session || {};\n    const model = createDefaultModel(question);\n    let correctness, score;\n    if (isUnanswered(session) && env.mode === 'evaluate') {\n      correctness = 'unanswered';\n      score = '0%';\n    } else {\n      correctness = getCorrectness(model, env, session && session.answers);\n      score = `${getOutComeScore(model, env, session && session.answers) * 100}%`;\n    }\n    const correctInfo = {\n      score,\n      correctness,\n    };\n    const out = {\n      env,\n      ...model,\n      view: env.mode === 'view' || env.mode === 'evaluate',\n    };\n    if (env.mode === 'evaluate') {\n      Object.assign(out, {\n        correctness: correctInfo,\n      });\n    }\n    resolve(out);\n  });\n};\n\n/*\n * Function to create a correct response session\n * @param {model} model contains the model object\n * @param {env} env contains the environment object\n * @returns {Promise} returns the correct response session\n * */\nexport const createCorrectResponseSession = (model, env) => {\n  return new Promise((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const { correctResponse, maxModelSelected, partsPerModel } = model;\n      resolve({\n        answers: {\n          response: correctResponse,\n          noOfModel: maxModelSelected,\n          partsPerModel,\n        },\n        id: '1',\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n\n/*\n * Function to validate the model\n * @param {model} model contains the model object\n * @param {config} config contains the config object\n * */\nexport const validate = (model = {}, config = {}) => {\n  const errors = {};\n  if (model.correctResponse.length === 0) {\n    errors.correctResponse = 'To save the item, at least one section must be marked as correct.';\n  }\n  if (model.correctResponse.length > 0) {\n    let partialModelCount = 0;\n    model.correctResponse.forEach((selection) => {\n      if (selection.value !== model.partsPerModel) {\n        partialModelCount++;\n      }\n    });\n    if (partialModelCount > 1) {\n      errors.correctResponse = 'The correct answer should include no more than one partially-filled model';\n    }\n  }\n  return errors;\n};\n"],"mappings":";;AAGA,IAAA,IAAe,EACb,OAAO;CACL,iBAAiB,CAAC;CAClB,OAAO;CACP,QAAQ;CACR,mBAAmB;CACnB,kBAAkB;CAClB,eAAe;CACf,sBAAsB;CACtB,iBAAiB;AACnB,EACF,GCFa,KAA0B,GAAO,GAAS,IAAM,CAAC,MAAM;CAClE,IAAI;CAYJ,OAXA,AAOE,IAPE,EAAM,uBACE,CAAC,EACT,EAAQ,kBAAkB,EAAM,iBAChC,EAAiB,EAAQ,UAAU,EAAM,aAAa,KACtD,EAAe,EAAM,iBAAiB,EAAQ,QAAQ,KAG9C,CAAC,EACT,EAAiB,EAAQ,UAAU,EAAM,aAAa,KAAK,EAAe,EAAM,iBAAiB,EAAQ,QAAQ,IAG9G,IAAU,YAAY;AAC/B,GASM,KAAkB,GAAU,GAAK,IAAU,CAAC,MAAM;CACtD,IAAI,EAAI,SAAS,YACf,OAAO,EAAuB,GAAU,GAAS,CAAG;AAExD,GASM,KAAmB,GAAU,GAAK,IAAU,CAAC,MAC7B,IAAe,GAAU,GAAK,CAC3C,MAAgB,YAInB,KAAgB,MAAY,CAAC,KAAW,EAAQ,CAAO,KAAK,CAAC,EAAQ,SAS9D,KAAW,GAAO,GAAS,MACtC,IAAI,SAAS,MAAY;CACvB,AAAI,EAAa,CAAO,IACtB,EAAQ;EAAE,OAAO;EAAG,OAAO;CAAK,CAAC,IAE7B,EAAI,SAAS,aAGf,EAAQ,EAAE,OAAO,EAAgB,GAAO,GAAK,EAAQ,OAAO,EAAE,CAAC,IAF/D,EAAQ;EAAE,OAAO,KAAA;EAAW,WAAW,KAAA;CAAU,CAAC;AAKxD,CAAC,GAQG,KAAkB,GAAiB,MAAa;CACpD,IAAI,IAAmB,GACnB,IAAoB;CACxB,KAAK,IAAI,IAAI,GAAG,IAAI,EAAgB,QAAQ,KAC1C,KAAoB,EAAgB,EAAE,CAAC;CAEzC,KAAK,IAAI,IAAI,GAAG,IAAI,EAAS,QAAQ,KACnC,KAAqB,EAAS,EAAE,CAAC;CAEnC,OAAO,MAAqB;AAC9B,GAOM,KAAoB,GAAU,MAAkB;CACpD,IAAI,EAAS,SAAS,GAAG;EACvB,IAAI,IAAoB;EAMxB,OALA,EAAS,SAAS,MAAc;GAC9B,AAAI,EAAU,UAAU,KACtB;EAEJ,CAAC,GACM,KAAqB;CAC9B,OACE,OAAO;AAEX,GAMa,KAAsB,IAAQ,CAAC,OAAO;CACjD,GAAG,EAAS;CACZ,GAAG;AACL,IAKa,KAAS,GAAU,GAAS,MAChC,IAAI,SAAS,MAAY;CAC9B,MAAqB,CAAC;CACtB,IAAM,IAAQ,EAAmB,CAAQ,GACrC,GAAa;CACjB,AAAI,EAAa,CAAO,KAAK,EAAI,SAAS,cACxC,IAAc,cACd,IAAQ,SAER,IAAc,EAAe,GAAO,GAAK,KAAW,EAAQ,OAAO,GACnE,IAAQ,GAAG,EAAgB,GAAO,GAAK,KAAW,EAAQ,OAAO,IAAI,IAAI;CAE3E,IAAM,IAAc;EAClB;EACA;CACF,GACM,IAAM;EACV;EACA,GAAG;EACH,MAAM,EAAI,SAAS,UAAU,EAAI,SAAS;CAC5C;CAMA,AALI,EAAI,SAAS,cACf,OAAO,OAAO,GAAK,EACjB,aAAa,EACf,CAAC,GAEH,EAAQ,CAAG;AACb,CAAC,GASU,KAAgC,GAAO,MAC3C,IAAI,SAAS,MAAY;CAC9B,IAAI,EAAI,SAAS,cAAc,EAAI,SAAS,cAAc;EACxD,IAAM,EAAE,oBAAiB,qBAAkB,qBAAkB;EAC7D,EAAQ;GACN,SAAS;IACP,UAAU;IACV,WAAW;IACX;GACF;GACA,IAAI;EACN,CAAC;CACH,OACE,EAAQ,IAAI;AAEhB,CAAC,GAQU,KAAY,IAAQ,CAAC,GAAG,IAAS,CAAC,MAAM;CACnD,IAAM,IAAS,CAAC;CAIhB,IAHI,EAAM,gBAAgB,WAAW,MACnC,EAAO,kBAAkB,sEAEvB,EAAM,gBAAgB,SAAS,GAAG;EACpC,IAAI,IAAoB;EAMxB,AALA,EAAM,gBAAgB,SAAS,MAAc;GAC3C,AAAI,EAAU,UAAU,EAAM,iBAC5B;EAEJ,CAAC,GACG,IAAoB,MACtB,EAAO,kBAAkB;CAE7B;CACA,OAAO;AACT"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../../src/controller/defaults.ts","../../../../src/controller/index.ts"],"sourcesContent":["import type { FractionModelModel, FractionModelResponse } from '../types.js';\n\n// Should be exactly the same as configure/defaults.js\nexport default {\n  model: {\n    correctResponse: [] as FractionModelResponse[],\n    title: '',\n    prompt: '',\n    modelTypeSelected: 'bar',\n    maxModelSelected: 1,\n    partsPerModel: 5,\n    allowedStudentConfig: false,\n    showGraphLabels: false,\n  },\n} satisfies { model: Omit<FractionModelModel, 'id' | 'element'> };\n","import { isEmpty } from '@pie-element/shared-lodash';\nimport type { PieEnvironment } from '@pie-element/shared-types';\nimport defaults from './defaults.js';\nimport type {\n  FractionModelAnswers,\n  FractionModelConfiguration,\n  FractionModelModel,\n  FractionModelResponse,\n  FractionModelSession,\n} from '../types.js';\n\n/** Whether a response matches the correct response */\nexport type FractionModelCorrectness = 'correct' | 'incorrect';\n\n/** What `outcome()` resolves: empty for an unanswered session, no score outside evaluate mode */\nexport type FractionModelOutcome =\n  | { score: number; empty: true }\n  | { score: undefined; completed: undefined }\n  | { score: number };\n\n/** Messages `validate()` returns, keyed by the model property they concern */\nexport type FractionModelValidationErrors = {\n  correctResponse?: string;\n};\n\n/*\n * Function to check the correctness of the response\n * @param {model} model contains the model object\n * @param {answers} answers contains the answers object\n * @param {env} env contains the environment object\n * @returns {string} returns the correctness of the response\n * */\nexport const getResponseCorrectness = (\n  model: Partial<FractionModelModel>,\n  answers: Partial<FractionModelAnswers>,\n  _env: Partial<PieEnvironment> = {}\n): FractionModelCorrectness => {\n  let correct;\n  // An absent `correctResponse` or `response` throws below, as it did untyped.\n  if (model.allowedStudentConfig) {\n    correct = !!(\n      answers.partsPerModel === model.partsPerModel &&\n      partialFillCheck(answers.response!, model.partsPerModel) &&\n      numeratorCheck(model.correctResponse!, answers.response!)\n    );\n  } else {\n    correct = !!(\n      partialFillCheck(answers.response!, model.partsPerModel) && numeratorCheck(model.correctResponse!, answers.response!)\n    );\n  }\n  return correct ? 'correct' : 'incorrect';\n};\n\n/*\n * Function to get the correctness of the response\n * @param {question} question contains the question object\n * @param {env} env contains the environment object\n * @param {answers} answers contains the answers object\n * @returns {string} returns the correctness\n * */\nconst getCorrectness = (\n  question: Partial<FractionModelModel>,\n  env: PieEnvironment,\n  answers: Partial<FractionModelAnswers> = {}\n): FractionModelCorrectness | undefined => {\n  if (env.mode === 'evaluate') {\n    return getResponseCorrectness(question, answers, env);\n  }\n};\n\n/*\n * Function to get the outcome score\n * @param {question} question contains the question object\n * @param {env} env contains the environment object\n * @param {answers} answers contains the answers object\n * @returns {number} returns the score\n * */\nconst getOutComeScore = (\n  question: Partial<FractionModelModel>,\n  env: PieEnvironment,\n  answers: Partial<FractionModelAnswers> = {}\n): number => {\n  const correctness = getCorrectness(question, env, answers);\n  return correctness === 'correct' ? 1 : 0;\n};\n\n// A player sends an untouched item's session as `{ id, element }`, without `answers`.\nconst isUnanswered = (session: FractionModelSession | null | undefined) =>\n  !session || isEmpty(session) || !session.answers;\n\n/*\n * Function to check outcome of the session\n * @param {model} model contains the model object\n * @param {session} session contains the session object\n * @param {env} env contains the environment object\n * @returns {Promise} returns the score\n */\nexport const outcome = (\n  model: FractionModelModel,\n  session: FractionModelSession | null | undefined,\n  env: PieEnvironment\n): Promise<FractionModelOutcome> =>\n  new Promise((resolve) => {\n    if (isUnanswered(session)) {\n      resolve({ score: 0, empty: true });\n    } else {\n      if (env.mode !== 'evaluate') {\n        resolve({ score: undefined, completed: undefined });\n      } else {\n        // isUnanswered() ruled out a missing session.\n        resolve({ score: getOutComeScore(model, env, session?.answers) });\n      }\n    }\n  });\n\n/*\n * Function to check if the numerator of the response matches the numerator of the correct response\n * @param {correctResponse} correctResponse contains the correct response object\n * @param {response} response contains the response object\n * @returns {boolean} returns true if the numerators match\n * */\nconst numeratorCheck = (correctResponse: FractionModelResponse[], response: FractionModelResponse[]) => {\n  let correctNumerator = 0;\n  let responseNumerator = 0;\n  for (let i = 0; i < correctResponse.length; i++) {\n    correctNumerator += correctResponse[i].value;\n  }\n  for (let i = 0; i < response.length; i++) {\n    responseNumerator += response[i].value;\n  }\n  return correctNumerator === responseNumerator;\n};\n\n/*\n * Function to check if the response contains more than one partially-filled model\n * @param {response} response contains the response object\n * @param {partsPerModel} partsPerModel contains the number of parts per model\n * */\nconst partialFillCheck = (response: FractionModelResponse[], partsPerModel: number | undefined) => {\n  if (response.length > 0) {\n    let partialModelCount = 0;\n    response.forEach((selection) => {\n      if (selection.value !== partsPerModel) {\n        partialModelCount++;\n      }\n    });\n    return partialModelCount <= 1;\n  } else {\n    return false;\n  }\n};\n\n/*\n * Function to create a default model\n * @param {model} model contains the model object\n * */\nexport const createDefaultModel = (model: Partial<FractionModelModel> = {}) => ({\n  ...defaults.model,\n  ...model,\n});\n\n/** A model with the controller defaults applied */\nexport type FractionModelNormalizedModel = ReturnType<typeof createDefaultModel>;\n\n/** What `model()` resolves */\nexport type FractionModelViewModel = FractionModelNormalizedModel & {\n  env: PieEnvironment;\n  /** Whether the student can no longer change the response */\n  view: boolean;\n  /** Set in evaluate mode */\n  correctness?: {\n    /** The score as a percentage, e.g. `100%` */\n    score: string;\n    correctness: FractionModelCorrectness | 'unanswered' | undefined;\n  };\n};\n\n/*\n * Return the model object\n * */\nexport const model = (\n  question: FractionModelModel,\n  session: FractionModelSession | null | undefined,\n  env: PieEnvironment\n): Promise<FractionModelViewModel> => {\n  return new Promise((resolve) => {\n    session = session || {};\n    const model = createDefaultModel(question);\n    let correctness: FractionModelCorrectness | 'unanswered' | undefined, score: string;\n    if (isUnanswered(session) && env.mode === 'evaluate') {\n      correctness = 'unanswered';\n      score = '0%';\n    } else {\n      correctness = getCorrectness(model, env, session && session.answers);\n      score = `${getOutComeScore(model, env, session && session.answers) * 100}%`;\n    }\n    const correctInfo = {\n      score,\n      correctness,\n    };\n    const out: FractionModelViewModel = {\n      env,\n      ...model,\n      view: env.mode === 'view' || env.mode === 'evaluate',\n    };\n    if (env.mode === 'evaluate') {\n      Object.assign(out, {\n        correctness: correctInfo,\n      });\n    }\n    resolve(out);\n  });\n};\n\n/*\n * Function to create a correct response session\n * @param {model} model contains the model object\n * @param {env} env contains the environment object\n * @returns {Promise} returns the correct response session\n * */\nexport const createCorrectResponseSession = (\n  model: FractionModelModel,\n  env: PieEnvironment\n): Promise<FractionModelSession | null> => {\n  return new Promise((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const { correctResponse, maxModelSelected, partsPerModel } = model;\n      resolve({\n        answers: {\n          // A model without `correctResponse` yields a session without `response`.\n          response: correctResponse as FractionModelResponse[],\n          noOfModel: maxModelSelected,\n          partsPerModel,\n        },\n        id: '1',\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n\n/*\n * Function to validate the model\n * @param {model} model contains the model object\n * @param {config} config contains the config object\n * */\nexport const validate = (\n  model: Partial<FractionModelModel> = {},\n  _config: FractionModelConfiguration = {}\n): FractionModelValidationErrors => {\n  const errors: FractionModelValidationErrors = {};\n  // An absent `correctResponse` throws here, as it did untyped.\n  if (model.correctResponse!.length === 0) {\n    errors.correctResponse = 'To save the item, at least one section must be marked as correct.';\n  }\n  if (model.correctResponse!.length > 0) {\n    let partialModelCount = 0;\n    model.correctResponse!.forEach((selection) => {\n      if (selection.value !== model.partsPerModel) {\n        partialModelCount++;\n      }\n    });\n    if (partialModelCount > 1) {\n      errors.correctResponse = 'The correct answer should include no more than one partially-filled model';\n    }\n  }\n  return errors;\n};\n"],"mappings":";;AAGA,IAAA,IAAe,EACb,OAAO;CACL,iBAAiB,CAAC;CAClB,OAAO;CACP,QAAQ;CACR,mBAAmB;CACnB,kBAAkB;CAClB,eAAe;CACf,sBAAsB;CACtB,iBAAiB;AACnB,EACF,GCkBa,KACX,GACA,GACA,IAAgC,CAAC,MACJ;CAC7B,IAAI;CAaJ,OAXA,AAOE,IAPE,EAAM,uBACE,CAAC,EACT,EAAQ,kBAAkB,EAAM,iBAChC,EAAiB,EAAQ,UAAW,EAAM,aAAa,KACvD,EAAe,EAAM,iBAAkB,EAAQ,QAAS,KAGhD,CAAC,EACT,EAAiB,EAAQ,UAAW,EAAM,aAAa,KAAK,EAAe,EAAM,iBAAkB,EAAQ,QAAS,IAGjH,IAAU,YAAY;AAC/B,GASM,KACJ,GACA,GACA,IAAyC,CAAC,MACD;CACzC,IAAI,EAAI,SAAS,YACf,OAAO,EAAuB,GAAU,GAAS,CAAG;AAExD,GASM,KACJ,GACA,GACA,IAAyC,CAAC,MAEtB,IAAe,GAAU,GAAK,CAC3C,MAAgB,YAInB,KAAgB,MACpB,CAAC,KAAW,EAAQ,CAAO,KAAK,CAAC,EAAQ,SAS9B,KACX,GACA,GACA,MAEA,IAAI,SAAS,MAAY;CACvB,AAAI,EAAa,CAAO,IACtB,EAAQ;EAAE,OAAO;EAAG,OAAO;CAAK,CAAC,IAE7B,EAAI,SAAS,aAIf,EAAQ,EAAE,OAAO,EAAgB,GAAO,GAAK,GAAS,OAAO,EAAE,CAAC,IAHhE,EAAQ;EAAE,OAAO,KAAA;EAAW,WAAW,KAAA;CAAU,CAAC;AAMxD,CAAC,GAQG,KAAkB,GAA0C,MAAsC;CACtG,IAAI,IAAmB,GACnB,IAAoB;CACxB,KAAK,IAAI,IAAI,GAAG,IAAI,EAAgB,QAAQ,KAC1C,KAAoB,EAAgB,EAAE,CAAC;CAEzC,KAAK,IAAI,IAAI,GAAG,IAAI,EAAS,QAAQ,KACnC,KAAqB,EAAS,EAAE,CAAC;CAEnC,OAAO,MAAqB;AAC9B,GAOM,KAAoB,GAAmC,MAAsC;CACjG,IAAI,EAAS,SAAS,GAAG;EACvB,IAAI,IAAoB;EAMxB,OALA,EAAS,SAAS,MAAc;GAC9B,AAAI,EAAU,UAAU,KACtB;EAEJ,CAAC,GACM,KAAqB;CAC9B,OACE,OAAO;AAEX,GAMa,KAAsB,IAAqC,CAAC,OAAO;CAC9E,GAAG,EAAS;CACZ,GAAG;AACL,IAqBa,KACX,GACA,GACA,MAEO,IAAI,SAAS,MAAY;CAC9B,MAAqB,CAAC;CACtB,IAAM,IAAQ,EAAmB,CAAQ,GACrC,GAAkE;CACtE,AAAI,EAAa,CAAO,KAAK,EAAI,SAAS,cACxC,IAAc,cACd,IAAQ,SAER,IAAc,EAAe,GAAO,GAAK,KAAW,EAAQ,OAAO,GACnE,IAAQ,GAAG,EAAgB,GAAO,GAAK,KAAW,EAAQ,OAAO,IAAI,IAAI;CAE3E,IAAM,IAAc;EAClB;EACA;CACF,GACM,IAA8B;EAClC;EACA,GAAG;EACH,MAAM,EAAI,SAAS,UAAU,EAAI,SAAS;CAC5C;CAMA,AALI,EAAI,SAAS,cACf,OAAO,OAAO,GAAK,EACjB,aAAa,EACf,CAAC,GAEH,EAAQ,CAAG;AACb,CAAC,GASU,KACX,GACA,MAEO,IAAI,SAAS,MAAY;CAC9B,IAAI,EAAI,SAAS,cAAc,EAAI,SAAS,cAAc;EACxD,IAAM,EAAE,oBAAiB,qBAAkB,qBAAkB;EAC7D,EAAQ;GACN,SAAS;IAEP,UAAU;IACV,WAAW;IACX;GACF;GACA,IAAI;EACN,CAAC;CACH,OACE,EAAQ,IAAI;AAEhB,CAAC,GAQU,KACX,IAAqC,CAAC,GACtC,IAAsC,CAAC,MACL;CAClC,IAAM,IAAwC,CAAC;CAK/C,IAHI,EAAM,gBAAiB,WAAW,MACpC,EAAO,kBAAkB,sEAEvB,EAAM,gBAAiB,SAAS,GAAG;EACrC,IAAI,IAAoB;EAMxB,AALA,EAAM,gBAAiB,SAAS,MAAc;GAC5C,AAAI,EAAU,UAAU,EAAM,iBAC5B;EAEJ,CAAC,GACG,IAAoB,MACtB,EAAO,kBAAkB;CAE7B;CACA,OAAO;AACT"}

package/dist/controller/defaults.d.ts

@@ -1,13 +1,14 @@
+import type { FractionModelResponse } from '../types.js';
 declare const _default: {
     model: {
-        correctResponse: never[];
+        correctResponse: FractionModelResponse[];
         title: string;
         prompt: string;
-        modelTypeSelected: string;
+        modelTypeSelected: "bar";
         maxModelSelected: number;
         partsPerModel: number;
-        allowedStudentConfig: boolean;
-        showGraphLabels: boolean;
+        allowedStudentConfig: false;
+        showGraphLabels: false;
     };
 };
 export default _default;

package/dist/controller/index.d.ts

@@ -1,15 +1,54 @@
-export declare const getResponseCorrectness: (model: any, answers: any, env?: {}) => "correct" | "incorrect";
-export declare const outcome: (model: any, session: any, env: any) => Promise<unknown>;
-export declare const createDefaultModel: (model?: {}) => {
-    correctResponse: never[];
+import type { PieEnvironment } from '@pie-element/shared-types';
+import type { FractionModelAnswers, FractionModelConfiguration, FractionModelModel, FractionModelResponse, FractionModelSession } from '../types.js';
+/** Whether a response matches the correct response */
+export type FractionModelCorrectness = 'correct' | 'incorrect';
+/** What `outcome()` resolves: empty for an unanswered session, no score outside evaluate mode */
+export type FractionModelOutcome = {
+    score: number;
+    empty: true;
+} | {
+    score: undefined;
+    completed: undefined;
+} | {
+    score: number;
+};
+/** Messages `validate()` returns, keyed by the model property they concern */
+export type FractionModelValidationErrors = {
+    correctResponse?: string;
+};
+export declare const getResponseCorrectness: (model: Partial<FractionModelModel>, answers: Partial<FractionModelAnswers>, _env?: Partial<PieEnvironment>) => FractionModelCorrectness;
+export declare const outcome: (model: FractionModelModel, session: FractionModelSession | null | undefined, env: PieEnvironment) => Promise<FractionModelOutcome>;
+export declare const createDefaultModel: (model?: Partial<FractionModelModel>) => {
+    correctResponse: FractionModelResponse[];
     title: string;
     prompt: string;
-    modelTypeSelected: string;
+    modelTypeSelected: "bar" | "pie";
     maxModelSelected: number;
     partsPerModel: number;
     allowedStudentConfig: boolean;
     showGraphLabels: boolean;
+    language?: string | undefined;
+    spellCheckEnabled?: boolean | undefined;
+    toolbarEditorPosition?: "bottom" | "top" | undefined;
+    extraCSSRules?: import("@pie-element/shared-types").ExtraCSSRules | undefined;
+    id?: string | undefined;
+    element?: string | undefined;
+    accessibilityCatalogs?: import("@pie-element/shared-types").AccessibilityCatalog[] | undefined;
+};
+/** A model with the controller defaults applied */
+export type FractionModelNormalizedModel = ReturnType<typeof createDefaultModel>;
+/** What `model()` resolves */
+export type FractionModelViewModel = FractionModelNormalizedModel & {
+    env: PieEnvironment;
+    /** Whether the student can no longer change the response */
+    view: boolean;
+    /** Set in evaluate mode */
+    correctness?: {
+        /** The score as a percentage, e.g. `100%` */
+        score: string;
+        correctness: FractionModelCorrectness | 'unanswered' | undefined;
+    };
 };
-export declare const model: (question: any, session: any, env: any) => Promise<unknown>;
-export declare const createCorrectResponseSession: (model: any, env: any) => Promise<unknown>;
-export declare const validate: (model?: {}, config?: {}) => {};
+export declare const model: (question: FractionModelModel, session: FractionModelSession | null | undefined, env: PieEnvironment) => Promise<FractionModelViewModel>;
+export declare const createCorrectResponseSession: (model: FractionModelModel, env: PieEnvironment) => Promise<FractionModelSession | null>;
+export declare const validate: (model?: Partial<FractionModelModel>, _config?: FractionModelConfiguration) => FractionModelValidationErrors;

package/dist/controller/index.js

@@ -10,7 +10,7 @@ var n = (e, t, n = {}) => {
 	a(t) ? r({
 		score: 0,
 		empty: !0
-	}) : n.mode === "evaluate" ? r({ score: i(e, n, t.answers) }) : r({
+	}) : n.mode === "evaluate" ? r({ score: i(e, n, t?.answers) }) : r({
 		score: void 0,
 		completed: void 0
 	});

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { default } from './delivery/index.js';
+export type * from './types.js';

package/dist/schemas/configuration.schema.json

@@ -0,0 +1,389 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/fraction-model@7.0.4/dist/schemas/configuration.schema.json",
+  "type": "object",
+  "properties": {
+    "baseInputConfiguration": {
+      "$ref": "#/definitions/EditableHtmlConfigureProp",
+      "description": "Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image"
+    },
+    "title": {
+      "$ref": "#/definitions/FractionModelFieldConfiguration",
+      "description": "Configuration for html input configuration regarding plugins that are enabled/disabled on item title E.g. audio, video, image"
+    },
+    "prompt": {
+      "$ref": "#/definitions/FractionModelFieldConfiguration",
+      "description": "Configuration for html input configuration regarding plugins that are enabled/disabled on question stem E.g. audio, video, image"
+    },
+    "modelOptions": {
+      "$ref": "#/definitions/FractionModelOptionsConfiguration",
+      "description": "Configuration for model options selection like Parts per model, max no. of models etc"
+    },
+    "mathMlOptions": {
+      "$ref": "#/definitions/ConfigureMathMLProp",
+      "description": "Configuration for editable-html"
+    },
+    "language": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Language configuration"
+    },
+    "languageChoices": {
+      "$ref": "#/definitions/ConfigureLanguageOptions",
+      "description": "Language choices configuration Only available if language is enabled"
+    },
+    "contentDimensions": {
+      "$ref": "#/definitions/ContentDimensions",
+      "description": "Dimensions of the authoring container"
+    },
+    "spellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Not read by this element: the model's `spellCheckEnabled` sets spellcheck"
+    },
+    "settingsPanelDisabled": {
+      "type": "boolean",
+      "description": "Not read by this element: the settings panel is always hidden"
+    },
+    "feedback": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Not read by this element: it has no feedback"
+    },
+    "showPrompt": {
+      "type": "boolean",
+      "description": "Not read by this element: the prompt is always shown"
+    },
+    "promptLabel": {
+      "type": "string",
+      "description": "Not read by this element: `prompt.label` labels the prompt"
+    },
+    "settingsPartialScoring": {
+      "type": "boolean",
+      "description": "Not read by this element: it has no partial scoring"
+    }
+  },
+  "description": "Config Object for `@pie-element/fraction-model`",
+  "definitions": {
+    "EditableHtmlConfigureProp": {
+      "type": "object",
+      "properties": {
+        "math": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "audio": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "video": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "image": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "customPlugins": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CustomPlugin"
+          },
+          "description": "An array of objects that determine custom plugins. A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when the button gets pressed (event)."
+        },
+        "blockquote": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "h3": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "characters": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "bold": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "html": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "italic": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "ol_list": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "redo": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "strikethrough": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "sub": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "sup": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "table": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "ul_list": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "underline": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "undo": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "textAlign": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "showParagraphs": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "separateParagraphs": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "pasteFormatting": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "superscript": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "subscript": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "languageCharacters": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        },
+        "responseArea": {
+          "$ref": "#/definitions/EditableHtmlButtonConfigure"
+        }
+      },
+      "description": "Toolbar plugins of an editable-html field, keyed by plugin name."
+    },
+    "EditableHtmlButtonConfigure": {
+      "type": "object",
+      "properties": {
+        "disabled": {
+          "type": "boolean",
+          "description": "Indicates if the plugin is disabled or not"
+        }
+      }
+    },
+    "CustomPlugin": {
+      "type": "object",
+      "properties": {
+        "event": {
+          "type": "string",
+          "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used). The event is emitted with the \"PIE-\" prefix."
+        },
+        "iconAlt": {
+          "type": "string",
+          "description": "The alt for the custom button icon"
+        },
+        "iconType": {
+          "type": "string",
+          "description": "The icon type. Currently, only \"SVG\" is supported."
+        },
+        "icon": {
+          "type": "string",
+          "description": "The icon string. Currently, only SVG is supported, so it needs to be a valid svg."
+        }
+      },
+      "required": [
+        "event",
+        "iconAlt",
+        "iconType",
+        "icon"
+      ]
+    },
+    "FractionModelFieldConfiguration": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Not read by this element: it has no settings panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label of the field"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Not read by this element: the field is always shown"
+        },
+        "inputConfiguration": {
+          "$ref": "#/definitions/EditableHtmlConfigureProp",
+          "description": "Configuration for editable-html"
+        }
+      },
+      "description": "Configuration for an editable field of the author"
+    },
+    "FractionModelOptionsConfiguration": {
+      "type": "object",
+      "properties": {
+        "maxOfModel": {
+          "$ref": "#/definitions/FractionModelNumberOption",
+          "description": "Indicates the max number of models for item"
+        },
+        "partsPerModel": {
+          "$ref": "#/definitions/FractionModelNumberOption",
+          "description": "Indicates the parts per model for item"
+        },
+        "modelTypeChoices": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/FractionModelTypeChoice"
+          },
+          "description": "Indicates the model types of item"
+        }
+      },
+      "description": "Configuration for model options selection like Parts per model, max no. of models etc"
+    },
+    "FractionModelNumberOption": {
+      "type": "object",
+      "properties": {
+        "min": {
+          "type": "number",
+          "description": "Indicates the min value for number model"
+        },
+        "max": {
+          "type": "number",
+          "description": "Indicates the max value for number model"
+        },
+        "default": {
+          "type": "number",
+          "description": "Not read by this element: the controller defaults set the starting value"
+        }
+      },
+      "description": "Bounds of a number the author sets"
+    },
+    "FractionModelTypeChoice": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "enum": [
+            "bar",
+            "pie"
+          ],
+          "description": "Indicates the value for model choice"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for model choice"
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ],
+      "description": "A model type the author can choose"
+    },
+    "ConfigureMathMLProp": {
+      "type": "object",
+      "properties": {
+        "mmlOutput": {
+          "type": "boolean",
+          "description": "Indicates if model should have mathML output instead of latex"
+        },
+        "mmlEditing": {
+          "type": "boolean",
+          "description": "Indicates if mathML that's already in model should be editable"
+        }
+      }
+    },
+    "ConfigurePropWithEnabled": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Indicates the value of the item if it affects config-ui (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)"
+        }
+      }
+    },
+    "ConfigureLanguageOptions": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConfigureLanguageOptionsProp"
+          }
+        }
+      },
+      "required": [
+        "label",
+        "options"
+      ]
+    },
+    "ConfigureLanguageOptionsProp": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "description": "Value of the language option"
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the language option"
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ]
+    },
+    "ContentDimensions": {
+      "type": "object",
+      "properties": {
+        "maxHeight": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "maxWidth": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "minHeight": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "minWidth": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "description": "Indicates the dimensions configuration for the authoring container. Note: Some items have a default minimum width because of their content, but if a lower minWidth is provided, it will be used."
+    },
+    "ConfigureProp": {
+      "type": "object",
+      "properties": {
+        "settings": {
+          "type": "boolean",
+          "description": "Indicates if the item has to be displayed in the Settings Panel"
+        },
+        "label": {
+          "type": "string",
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel"
+        }
+      },
+      "description": "Building blocks of an element's authoring configuration: the object a host passes to the `<tag>-config` custom element to decide which settings the author sees and how editors behave.\n\nEach element declares its own `<Name>Configuration` interface from these, and its JSON Schema is generated from that interface. Descriptions are carried over from the legacy `pie-elements` config schemas, so they appear in the generated schemas unchanged."
+    }
+  },
+  "additionalProperties": false
+}