@pie-element/matrix 5.0.4-next.20261011174919 → 5.0.4

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\nexport default {\n  columnLabels: ['COLUMN 1', 'COLUMN 2', 'COLUMN 3'],\n  labelType: 'agreement',\n  matrixValues: {},\n  prompt: '',\n  promptEnabled: true,\n  rowLabels: ['STATEMENT 1', 'STATEMENT 2'],\n  teacherInstructions: '',\n  teacherInstructionsEnabled: true,\n};\n","// @ts-nocheck\n\nimport defaults from './defaults.js';\nimport { isEmpty } from '@pie-element/shared-lodash';\n\nexport const createDefaultModel = (model = {}) => new Promise((resolve) => resolve({ ...defaults, ...model }));\n\n/**\n *\n * @param {*} question\n * @param {*} session\n * @param {*} env\n */\nexport async function model(question, session, env) {\n  const normalizedQuestion = { ...defaults, ...question };\n\n  const out = {\n    ...normalizedQuestion,\n    disabled: env.mode !== 'gather',\n    mode: env.mode,\n  };\n\n  const { role, mode } = env || {};\n\n  if (role === 'instructor' && (mode === 'view' || mode === 'evaluate')) {\n    out.teacherInstructions = normalizedQuestion.teacherInstructionsEnabled\n      ? normalizedQuestion.teacherInstructions\n      : null;\n  } else {\n    out.teacherInstructions = null;\n  }\n\n  return out;\n}\n\nexport function outcome(model, session) {\n  return new Promise((resolve) => {\n    // A player sends an untouched item's session as `{ id, element }`, without `value`.\n    if (!session || isEmpty(session) || !session.value) {\n      return resolve({ score: 0, empty: true });\n    }\n\n    const score = Object.keys(session.value).reduce((acc, key) => {\n      const matrixValue = model.matrixValues[key];\n      return acc + (matrixValue || 0);\n    }, 0);\n\n    resolve({ score, empty: false });\n  });\n}\n\nexport const createCorrectResponseSession = (question, env) => {\n  return new Promise((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const { matrixValues } = question || [];\n\n      resolve({\n        id: '1',\n        value: matrixValues,\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n\n// remove all html tags\nconst getInnerText = (html) => (html || '').replaceAll(/<[^>]*>/g, '');\n\n// remove all html tags except img, iframe and source tag for audio\nconst getContent = (html) => (html || '').replace(/(<(?!img|iframe|source)([^>]+)>)/gi, '');\n\nexport const validate = (model = {}, config = {}) => {\n  const errors = {};\n\n  ['teacherInstructions', 'prompt'].forEach((field) => {\n    if (config[field]?.required && !getContent(model[field])) {\n      errors[field] = 'This field is required.';\n    }\n  });\n\n  return errors;\n};\n"],"mappings":";;AAEA,IAAA,IAAe;CACb,cAAc;EAAC;EAAY;EAAY;CAAU;CACjD,WAAW;CACX,cAAc,CAAC;CACf,QAAQ;CACR,eAAe;CACf,WAAW,CAAC,eAAe,aAAa;CACxC,qBAAqB;CACrB,4BAA4B;AAC9B,GCNa,KAAsB,IAAQ,CAAC,MAAM,IAAI,SAAS,MAAY,EAAQ;CAAE,GAAG;CAAU,GAAG;AAAM,CAAC,CAAC;AAQ7G,eAAsB,EAAM,GAAU,GAAS,GAAK;CAClD,IAAM,IAAqB;EAAE,GAAG;EAAU,GAAG;CAAS,GAEhD,IAAM;EACV,GAAG;EACH,UAAU,EAAI,SAAS;EACvB,MAAM,EAAI;CACZ,GAEM,EAAE,SAAM,YAAS,KAAO,CAAC;CAU/B,OARI,MAAS,iBAAiB,MAAS,UAAU,MAAS,cACxD,EAAI,sBAAsB,EAAmB,6BACzC,EAAmB,sBACnB,OAEJ,EAAI,sBAAsB,MAGrB;AACT;AAEA,SAAgB,EAAQ,GAAO,GAAS;CACtC,OAAO,IAAI,SAAS,MAAY;EAE9B,IAAI,CAAC,KAAW,EAAQ,CAAO,KAAK,CAAC,EAAQ,OAC3C,OAAO,EAAQ;GAAE,OAAO;GAAG,OAAO;EAAK,CAAC;EAQ1C,EAAQ;GAAE,OALI,OAAO,KAAK,EAAQ,KAAK,CAAC,CAAC,QAAQ,GAAK,MAE7C,KADa,EAAM,aAAa,MACV,IAC5B,CAEO;GAAO,OAAO;EAAM,CAAC;CACjC,CAAC;AACH;AAEA,IAAa,KAAgC,GAAU,MAC9C,IAAI,SAAS,MAAY;CAC9B,IAAI,EAAI,SAAS,cAAc,EAAI,SAAS,cAAc;EACxD,IAAM,EAAE,oBAAiB,KAAY,CAAC;EAEtC,EAAQ;GACN,IAAI;GACJ,OAAO;EACT,CAAC;CACH,OACE,EAAQ,IAAI;AAEhB,CAAC,GAOG,KAAc,OAAU,KAAQ,GAAA,CAAI,QAAQ,sCAAsC,EAAE,GAE7E,KAAY,IAAQ,CAAC,GAAG,IAAS,CAAC,MAAM;CACnD,IAAM,IAAS,CAAC;CAQhB,OANA,CAAC,uBAAuB,QAAQ,CAAC,CAAC,SAAS,MAAU;EACnD,AAAI,EAAO,EAAM,EAAE,YAAY,CAAC,EAAW,EAAM,EAAM,MACrD,EAAO,KAAS;CAEpB,CAAC,GAEM;AACT"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../../src/controller/defaults.ts","../../../../src/controller/index.ts"],"sourcesContent":["import type { MatrixModel } from '../types.js';\n\nexport default {\n  columnLabels: ['COLUMN 1', 'COLUMN 2', 'COLUMN 3'],\n  labelType: 'agreement',\n  matrixValues: {} as Record<string, number>,\n  prompt: '',\n  promptEnabled: true,\n  rowLabels: ['STATEMENT 1', 'STATEMENT 2'],\n  teacherInstructions: '',\n  teacherInstructionsEnabled: true,\n} satisfies Omit<MatrixModel, 'id' | 'element'>;\n","import defaults from './defaults.js';\nimport { isEmpty } from '@pie-element/shared-lodash';\nimport type { PieEnvironment } from '@pie-element/shared-types';\nimport type { MatrixConfiguration, MatrixModel, MatrixSession } from '../types.js';\n\n/** Errors `validate()` reports. */\nexport type MatrixValidationErrors = {\n  teacherInstructions?: string;\n  prompt?: string;\n};\n\n/** The model `model()` hands the delivery. */\ntype MatrixViewModel = Omit<MatrixModel, 'teacherInstructions'> & {\n  disabled: boolean;\n  mode: PieEnvironment['mode'];\n  teacherInstructions?: string | null;\n};\n\nexport const createDefaultModel = (model: Partial<MatrixModel> = {}) =>\n  new Promise<Partial<MatrixModel>>((resolve) => resolve({ ...defaults, ...model }));\n\n/**\n *\n * @param {*} question\n * @param {*} session\n * @param {*} env\n */\nexport async function model(question: MatrixModel, _session: MatrixSession | undefined, env: PieEnvironment) {\n  const normalizedQuestion = { ...defaults, ...question };\n\n  const out: MatrixViewModel = {\n    ...normalizedQuestion,\n    disabled: env.mode !== 'gather',\n    mode: env.mode,\n  };\n\n  const { role, mode } = env || {};\n\n  if (role === 'instructor' && (mode === 'view' || mode === 'evaluate')) {\n    out.teacherInstructions = normalizedQuestion.teacherInstructionsEnabled\n      ? normalizedQuestion.teacherInstructions\n      : null;\n  } else {\n    out.teacherInstructions = null;\n  }\n\n  return out;\n}\n\nexport function outcome(model: MatrixModel, session: MatrixSession | undefined) {\n  return new Promise<{ score: number; empty: boolean }>((resolve) => {\n    // A player sends an untouched item's session as `{ id, element }`, without `value`.\n    if (!session || isEmpty(session) || !session.value) {\n      return resolve({ score: 0, empty: true });\n    }\n\n    const score = Object.keys(session.value).reduce((acc, key) => {\n      // `model` is not normalized here, so a model without `matrixValues` throws\n      const matrixValue = (model.matrixValues as Record<string, number>)[key];\n      return acc + (matrixValue || 0);\n    }, 0);\n\n    resolve({ score, empty: false });\n  });\n}\n\nexport const createCorrectResponseSession = (question: MatrixModel, env: PieEnvironment) => {\n  return new Promise<MatrixSession | null>((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const { matrixValues } = question || [];\n\n      resolve({\n        id: '1',\n        value: matrixValues,\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n\n// remove all html tags except img, iframe and source tag for audio\nconst getContent = (html: string | undefined) => (html || '').replace(/(<(?!img|iframe|source)([^>]+)>)/gi, '');\n\nexport const validate = (\n  model: Partial<MatrixModel> = {},\n  config: MatrixConfiguration = {},\n): MatrixValidationErrors => {\n  const errors: MatrixValidationErrors = {};\n\n  (['teacherInstructions', 'prompt'] as const).forEach((field) => {\n    if (config[field]?.required && !getContent(model[field])) {\n      errors[field] = 'This field is required.';\n    }\n  });\n\n  return errors;\n};\n"],"mappings":";;AAEA,IAAA,IAAe;CACb,cAAc;EAAC;EAAY;EAAY;CAAU;CACjD,WAAW;CACX,cAAc,CAAC;CACf,QAAQ;CACR,eAAe;CACf,WAAW,CAAC,eAAe,aAAa;CACxC,qBAAqB;CACrB,4BAA4B;AAC9B,GCOa,KAAsB,IAA8B,CAAC,MAChE,IAAI,SAA+B,MAAY,EAAQ;CAAE,GAAG;CAAU,GAAG;AAAM,CAAC,CAAC;AAQnF,eAAsB,EAAM,GAAuB,GAAqC,GAAqB;CAC3G,IAAM,IAAqB;EAAE,GAAG;EAAU,GAAG;CAAS,GAEhD,IAAuB;EAC3B,GAAG;EACH,UAAU,EAAI,SAAS;EACvB,MAAM,EAAI;CACZ,GAEM,EAAE,SAAM,YAAS,KAAO,CAAC;CAU/B,OARI,MAAS,iBAAiB,MAAS,UAAU,MAAS,cACxD,EAAI,sBAAsB,EAAmB,6BACzC,EAAmB,sBACnB,OAEJ,EAAI,sBAAsB,MAGrB;AACT;AAEA,SAAgB,EAAQ,GAAoB,GAAoC;CAC9E,OAAO,IAAI,SAA4C,MAAY;EAEjE,IAAI,CAAC,KAAW,EAAQ,CAAO,KAAK,CAAC,EAAQ,OAC3C,OAAO,EAAQ;GAAE,OAAO;GAAG,OAAO;EAAK,CAAC;EAS1C,EAAQ;GAAE,OANI,OAAO,KAAK,EAAQ,KAAK,CAAC,CAAC,QAAQ,GAAK,MAG7C,KADc,EAAM,aAAwC,MACtC,IAC5B,CAEO;GAAO,OAAO;EAAM,CAAC;CACjC,CAAC;AACH;AAEA,IAAa,KAAgC,GAAuB,MAC3D,IAAI,SAA+B,MAAY;CACpD,IAAI,EAAI,SAAS,cAAc,EAAI,SAAS,cAAc;EACxD,IAAM,EAAE,oBAAiB,KAAY,CAAC;EAEtC,EAAQ;GACN,IAAI;GACJ,OAAO;EACT,CAAC;CACH,OACE,EAAQ,IAAI;AAEhB,CAAC,GAIG,KAAc,OAA8B,KAAQ,GAAA,CAAI,QAAQ,sCAAsC,EAAE,GAEjG,KACX,IAA8B,CAAC,GAC/B,IAA8B,CAAC,MACJ;CAC3B,IAAM,IAAiC,CAAC;CAQxC,OANA,CAAE,uBAAuB,QAAQ,CAAC,CAAW,SAAS,MAAU;EAC9D,AAAI,EAAO,EAAM,EAAE,YAAY,CAAC,EAAW,EAAM,EAAM,MACrD,EAAO,KAAS;CAEpB,CAAC,GAEM;AACT"}

package/dist/controller/defaults.d.ts

@@ -1,11 +1,11 @@
 declare const _default: {
     columnLabels: string[];
-    labelType: string;
-    matrixValues: {};
+    labelType: "agreement";
+    matrixValues: Record<string, number>;
     prompt: string;
-    promptEnabled: boolean;
+    promptEnabled: true;
     rowLabels: string[];
     teacherInstructions: string;
-    teacherInstructionsEnabled: boolean;
+    teacherInstructionsEnabled: true;
 };
 export default _default;

package/dist/controller/index.d.ts

@@ -1,11 +1,28 @@
-export declare const createDefaultModel: (model?: {}) => Promise<unknown>;
+import type { PieEnvironment } from '@pie-element/shared-types';
+import type { MatrixConfiguration, MatrixModel, MatrixSession } from '../types.js';
+/** Errors `validate()` reports. */
+export type MatrixValidationErrors = {
+    teacherInstructions?: string;
+    prompt?: string;
+};
+/** The model `model()` hands the delivery. */
+type MatrixViewModel = Omit<MatrixModel, 'teacherInstructions'> & {
+    disabled: boolean;
+    mode: PieEnvironment['mode'];
+    teacherInstructions?: string | null;
+};
+export declare const createDefaultModel: (model?: Partial<MatrixModel>) => Promise<Partial<MatrixModel>>;
 /**
  *
  * @param {*} question
  * @param {*} session
  * @param {*} env
  */
-export declare function model(question: any, session: any, env: any): Promise<any>;
-export declare function outcome(model: any, session: any): Promise<unknown>;
-export declare const createCorrectResponseSession: (question: any, env: any) => Promise<unknown>;
-export declare const validate: (model?: {}, config?: {}) => {};
+export declare function model(question: MatrixModel, _session: MatrixSession | undefined, env: PieEnvironment): Promise<MatrixViewModel>;
+export declare function outcome(model: MatrixModel, session: MatrixSession | undefined): Promise<{
+    score: number;
+    empty: boolean;
+}>;
+export declare const createCorrectResponseSession: (question: MatrixModel, env: PieEnvironment) => Promise<MatrixSession | null>;
+export declare const validate: (model?: Partial<MatrixModel>, config?: MatrixConfiguration) => MatrixValidationErrors;
+export {};

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,263 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/matrix@5.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"
+    },
+    "settingsPanelDisabled": {
+      "type": "boolean",
+      "description": "Indicates if the settings panel is not available"
+    },
+    "spellCheck": {
+      "$ref": "#/definitions/ConfigurePropWithEnabled",
+      "description": "Configuration for the author's spellcheck; `enabled` is not read, the model's `spellCheckEnabled` turns it on"
+    },
+    "teacherInstructions": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Teacher Instructions configuration"
+    },
+    "prompt": {
+      "$ref": "#/definitions/EditableHtmlPluginConfigureRequired",
+      "description": "Configuration for the prompt"
+    },
+    "scoringType": {
+      "$ref": "#/definitions/ConfigureProp",
+      "description": "Scoring Type configuration"
+    },
+    "contentDimensions": {
+      "$ref": "#/definitions/ContentDimensions",
+      "description": "Dimensions of the authoring container"
+    },
+    "showPrompt": {
+      "type": "boolean",
+      "description": "Not read by this element: the prompt always shows"
+    },
+    "promptLabel": {
+      "type": "string",
+      "description": "Not read by this element: `prompt.label` labels the prompt"
+    },
+    "settingsPartialScoring": {
+      "type": "boolean",
+      "description": "Not read by this element, which has no partial scoring"
+    }
+  },
+  "description": "Config Object for `@pie-element/matrix`",
+  "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"
+      ]
+    },
+    "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)"
+        }
+      }
+    },
+    "EditableHtmlPluginConfigureRequired": {
+      "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"
+        },
+        "inputConfiguration": {
+          "$ref": "#/definitions/EditableHtmlConfigureProp",
+          "description": "Configuration for editable-html"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Indicates if the item is required and the value cannot be empty"
+        }
+      }
+    },
+    "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."
+    },
+    "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."
+    }
+  },
+  "additionalProperties": false
+}