@pie-element/charting 13.0.4-next.20261011174919 → 13.0.4

package/dist/schemas/model.schema.json

@@ -0,0 +1,594 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/charting@13.0.4/dist/schemas/model.schema.json",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config."
+    },
+    "element": {
+      "type": "string",
+      "description": "The html Element tag name: the key in the item config's `elements` map, e.g. \"multiple-choice\""
+    },
+    "accessibilityCatalogs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/AccessibilityCatalog"
+      },
+      "description": "QTI-aligned accessibility catalogs whose cards dock to content nodes by `data-catalog-idref`"
+    },
+    "addCategoryEnabled": {
+      "type": "boolean",
+      "description": "Indicates if user can add more categories",
+      "default": true
+    },
+    "chartType": {
+      "$ref": "#/definitions/ChartingChartType",
+      "description": "Indicates the chart type",
+      "default": "lineCross"
+    },
+    "correctAnswer": {
+      "$ref": "#/definitions/ChartingCorrectAnswer",
+      "description": "Indicates marks that are set as answers"
+    },
+    "data": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/ChartingCategory"
+      },
+      "description": "Indicates default categories for the answer"
+    },
+    "domain": {
+      "$ref": "#/definitions/ChartingDomain",
+      "description": "Indicates domain settings for the chart"
+    },
+    "graph": {
+      "$ref": "#/definitions/ChartingGraph",
+      "description": "Indicates the chart line model; 480 by 480 when absent"
+    },
+    "prompt": {
+      "type": "string",
+      "description": "Indicates prompt value"
+    },
+    "promptEnabled": {
+      "type": "boolean",
+      "description": "Indicates if the prompt is enabled",
+      "default": true
+    },
+    "range": {
+      "$ref": "#/definitions/ChartingRange",
+      "description": "Indicates range settings for the chart"
+    },
+    "rationale": {
+      "type": "string",
+      "description": "Indicates rationale for the answer"
+    },
+    "rationaleEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Rationale are enabled",
+      "default": true
+    },
+    "scoringType": {
+      "type": "string",
+      "enum": [
+        "all or nothing",
+        "partial scoring"
+      ],
+      "description": "Indicates scoring type. `model()` applies the default when absent; `outcome()` scores an absent value as partial scoring unless the environment turns partial scoring off.",
+      "default": "all or nothing"
+    },
+    "studentInstructions": {
+      "type": "string",
+      "description": "Not read by this element: it has no student instructions"
+    },
+    "studentInstructionsEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Student Instructions are enabled. Not read by this element: it has no student instructions.",
+      "default": true
+    },
+    "teacherInstructions": {
+      "type": "string",
+      "description": "Indicates teacher instructions"
+    },
+    "teacherInstructionsEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Teacher Instructions are enabled",
+      "default": true
+    },
+    "title": {
+      "type": "string",
+      "description": "Indicates chart title"
+    },
+    "placeholderMessages": {
+      "$ref": "#/definitions/ChartingPlaceholderMessages",
+      "description": "Not read by this element: the configuration's `titlePlaceholder` and `labelsPlaceholders` set the placeholders"
+    },
+    "spellCheckEnabled": {
+      "type": "boolean",
+      "description": "Indicates if spellcheck is enabled for the author. Default value is true"
+    },
+    "rubricEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Rubric is enabled. Not read by this element: the settings panel sets it when `withRubric.settings` is on."
+    },
+    "changeInteractiveEnabled": {
+      "type": "boolean",
+      "description": "Indicates if teacher can enable/disable data[]:interactive",
+      "default": false
+    },
+    "changeEditableEnabled": {
+      "type": "boolean",
+      "description": "Indicates if teacher can enable/disable data[]:editable",
+      "default": false
+    },
+    "changeAddCategoryEnabled": {
+      "type": "boolean",
+      "description": "Indicates if teacher can enable/disable addCategoryEnabled",
+      "default": false
+    },
+    "studentNewCategoryDefaultLabel": {
+      "type": "string",
+      "description": "Label for new category in correct response and player's chart",
+      "default": "New Category"
+    },
+    "language": {
+      "type": "string",
+      "description": "Indicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX"
+    },
+    "extraCSSRules": {
+      "$ref": "#/definitions/ExtraCSSRules",
+      "description": "Host-supplied CSS scoped to the element"
+    }
+  },
+  "required": [
+    "element",
+    "id"
+  ],
+  "description": "Model Object for `@pie-element/charting`",
+  "definitions": {
+    "AccessibilityCatalog": {
+      "type": "object",
+      "properties": {
+        "identifier": {
+          "type": "string"
+        },
+        "cards": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CatalogCard"
+          }
+        }
+      },
+      "required": [
+        "identifier",
+        "cards"
+      ]
+    },
+    "CatalogCard": {
+      "type": "object",
+      "properties": {
+        "catalog": {
+          "type": "string"
+        },
+        "language": {
+          "type": "string"
+        },
+        "content": {
+          "type": "string"
+        },
+        "payload": {
+          "$ref": "#/definitions/CatalogCardPayload"
+        }
+      },
+      "required": [
+        "catalog"
+      ],
+      "description": "QTI-aligned accessibility catalog entry: one alternate representation of a content node, docked to it by `data-catalog-idref`.\n\nMaps onto QTI 3's `qti-card`. `catalog` is QTI's `@support` and is the only discriminant — there is deliberately no second `kind` field. `language` is the card entry's `xml:lang`. QTI's single content slot is represented by exactly one of two fields, never both, with nothing mirrored between them:\n\n- `content` — the string form, for alternates a string can express: SSML for   `spoken`, plain text for `simplified-language`.\n- `payload` — the structured form, for what a string cannot express. Today   only a signing video.\n\nOne generic payload slot rather than a field per accommodation (`signLanguage`, `braille`, …), which is the shape pie-players canonicalises and the shape this repo now follows. A field per accommodation makes every new structured alternate a breaking widening of this type in every consumer that reads cards, and it gives the same fact two names across repos — which produced a real bug: a card carrying `signLanguage` rendered its video in the player and was simultaneously reported as carrying no payload by the player's \"what alternates exist\" path, because only one of the two read paths knew about the alias.\n\n`catalog` is a bare `string` because the vocabulary is open-ended and unknown tokens must be ignored rather than rejected. TypeScript therefore cannot express \"a `sign-language` card must carry a payload\", so a `{ catalog: 'sign-language', content: '<url>' }` object still satisfies this type. That legacy bare-URL form is not supported: runtime validation on the consuming side must reject it rather than render the URL as visible text. Narrow with `isSignLanguageCard`."
+    },
+    "CatalogCardPayload": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/SignLanguageCardPayload"
+        },
+        {
+          "$ref": "#/definitions/SpokenAudioCardPayload"
+        }
+      ],
+      "description": "The structured forms a card's `payload` may take.\n\nWhich one applies is decided by the card's `catalog`, so this union carries no discriminant of its own — a second discriminant could contradict the first. Consumers select a card by catalog type and then validate the payload structurally, which they must do regardless: catalog data is authored, wire-facing and untrusted."
+    },
+    "SignLanguageCardPayload": {
+      "type": "object",
+      "properties": {
+        "signLang": {
+          "type": "string",
+          "description": "Language tag for the signed translation — BCP 47, which admits ISO 639-3 subtags for languages with no 639-1/2 code. \"ase\" is ASL, matching QTI 3 `xml:lang`.\n\nThis is the language of the *adaptation*, not the item's base content language (AfA/PNP's `languageOfAdaptation`). The distinction is load bearing: a Spanish item's signed alternate is LSM, not ASL, so `signLang` must never be inferred from the item or assessment content language.\n\nOptional, and redundant on almost every card. The card's `language` states the same code and is the only field pie-players resolves a card on — resolution runs before anything knows the card is a signing card, so it can only key on the generic field — and the player falls back to it when this is absent. Author it only where the two differ: a card tagged with the item's content language (`language: 'en-US'`, `signLang: 'ase'`) so resolution reaches it by the default-language rung. The pie-api-aws importer emits `language` alone."
+        },
+        "media": {
+          "$ref": "#/definitions/MediaAssetRef"
+        },
+        "fragment": {
+          "$ref": "#/definitions/MediaFragmentRange"
+        }
+      },
+      "required": [
+        "media"
+      ],
+      "description": "Payload for a `sign-language` catalog card: a signed translation of the content node the card is docked to."
+    },
+    "MediaAssetRef": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "number",
+          "const": 1
+        },
+        "id": {
+          "type": "string"
+        },
+        "kind": {
+          "$ref": "#/definitions/MediaKind"
+        },
+        "sources": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/MediaSource"
+          }
+        },
+        "poster": {
+          "type": "string"
+        },
+        "thumbnail": {
+          "type": "string"
+        },
+        "durationSeconds": {
+          "type": "number"
+        },
+        "tracks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TextTrackRef"
+          }
+        },
+        "transcript": {
+          "$ref": "#/definitions/TranscriptRef"
+        },
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "lang": {
+          "type": "string",
+          "description": "Language of the asset itself, as authored metadata. Sign-language cards leave it unset: the card's `language` already states the adaptation language, and a second copy is a second thing to keep in agreement."
+        }
+      },
+      "required": [
+        "version",
+        "id",
+        "kind",
+        "sources"
+      ],
+      "description": "Reference to a media asset and its playable encodings.\n\nStructurally mirrors the `MediaAssetRef` in the pie-players `media-asset-contract` PRD. The two definitions are deliberately kept as separate declarations rather than a shared package dependency: this repo owns the item-model side of the contract, pie-players owns the player side, and both read the same authored JSON, so structural typing is sufficient for interop. Fixture parity — not a package edge — is what pins them together.\n\nSign-language catalog cards were the first consumer and use only the core source fields. The optional presentation, track, and transcript metadata is declared for broader consumers such as video stimuli; it remains meaningless for a signing clip, where captions would duplicate the text already on screen."
+    },
+    "MediaKind": {
+      "type": "string",
+      "enum": [
+        "image",
+        "audio",
+        "video",
+        "other"
+      ]
+    },
+    "MediaSource": {
+      "type": "object",
+      "properties": {
+        "src": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "description": "MIME type, e.g. \"video/mp4\"."
+        },
+        "width": {
+          "type": "number"
+        },
+        "height": {
+          "type": "number"
+        },
+        "bitrate": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "src"
+      ],
+      "description": "One playable encoding of a media asset."
+    },
+    "TextTrackRef": {
+      "type": "object",
+      "properties": {
+        "src": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "captions",
+            "subtitles",
+            "descriptions",
+            "chapters",
+            "metadata"
+          ]
+        },
+        "lang": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "default": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "src",
+        "kind",
+        "lang",
+        "label"
+      ],
+      "description": "One authored text track associated with an audio or video asset."
+    },
+    "TranscriptRef": {
+      "type": "object",
+      "properties": {
+        "src": {
+          "type": "string"
+        },
+        "html": {
+          "type": "string"
+        },
+        "plainText": {
+          "type": "string"
+        },
+        "lang": {
+          "type": "string"
+        }
+      },
+      "description": "Inline or externally hosted transcript content for a media asset."
+    },
+    "MediaFragmentRange": {
+      "type": "object",
+      "properties": {
+        "startSeconds": {
+          "type": "number"
+        },
+        "endSeconds": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "startSeconds"
+      ],
+      "description": "A time slice within a media asset, so one recording can serve several content nodes. Mirrors QTI 3's Media Fragments URI usage."
+    },
+    "SpokenAudioCardPayload": {
+      "type": "object",
+      "properties": {
+        "media": {
+          "$ref": "#/definitions/MediaAssetRef"
+        },
+        "fragment": {
+          "$ref": "#/definitions/MediaFragmentRange"
+        }
+      },
+      "required": [
+        "media"
+      ],
+      "description": "Payload for a `spoken` catalog card that is a recording rather than a script.\n\nQTI 3 treats recorded audio and synthesized speech as the same support: both are `spoken`, so this is not a new accommodation, it is the other form the existing one can take. A node commonly carries both this and a `content` card in the same language — the script is both what the audio was generated from and the fallback for when the audio cannot play; pie-players resolves between them with `CatalogLookupOptions.form`.\n\nNo `kind` discriminant, for the same reason `SignLanguageCardPayload` has none: the card's `catalog` already says what this is."
+    },
+    "ChartingChartType": {
+      "type": "string",
+      "enum": [
+        "bar",
+        "histogram",
+        "lineDot",
+        "lineCross",
+        "dotPlot",
+        "linePlot"
+      ],
+      "description": "The chart types the element renders"
+    },
+    "ChartingCorrectAnswer": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Indicates name of answer; the author keys the correct-response chart by it"
+        },
+        "data": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ChartingCategory"
+          },
+          "description": "Indicates marks for the answer"
+        }
+      },
+      "description": "Marks that are set as answers"
+    },
+    "ChartingCategory": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Indicates category label"
+        },
+        "value": {
+          "type": "number",
+          "description": "Indicates category value"
+        },
+        "interactive": {
+          "type": "boolean",
+          "description": "Indicates if category value is interactive"
+        },
+        "editable": {
+          "type": "boolean",
+          "description": "Indicates if category label is editable"
+        },
+        "deletable": {
+          "type": "boolean",
+          "description": "Indicates if category is deletable"
+        },
+        "index": {
+          "type": "number",
+          "description": "Position of the category in the author's chart; scoring reports it with each correct category"
+        },
+        "correctness": {
+          "$ref": "#/definitions/ChartingCategoryCorrectness",
+          "description": "Indicates correctness for a category"
+        }
+      },
+      "required": [
+        "label",
+        "value"
+      ],
+      "description": "A category on the chart: a bar, a point on a line or a column of a plot"
+    },
+    "ChartingCategoryCorrectness": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "enum": [
+            "correct",
+            "incorrect"
+          ]
+        },
+        "label": {
+          "type": "string",
+          "enum": [
+            "correct",
+            "incorrect"
+          ]
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ],
+      "description": "Whether a category's value or label matches the correct answer; the controller sets it when scoring"
+    },
+    "ChartingDomain": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Axis label"
+        },
+        "min": {
+          "type": "number",
+          "description": "Not read by this element: the chart fixes the category axis to 0–1"
+        },
+        "max": {
+          "type": "number",
+          "description": "Not read by this element: the chart fixes the category axis to 0–1"
+        },
+        "step": {
+          "type": "number",
+          "description": "Not read by this element: the chart fixes the category axis step to 1"
+        },
+        "labelStep": {
+          "type": "number",
+          "description": "Not read by this element: the chart fixes the category axis label step to 1"
+        },
+        "axisLabel": {
+          "type": "string",
+          "description": "Not read by this element: `label` labels the axis"
+        }
+      },
+      "description": "Settings for the category axis"
+    },
+    "ChartingGraph": {
+      "type": "object",
+      "properties": {
+        "width": {
+          "type": "number",
+          "description": "Width for chart representation"
+        },
+        "height": {
+          "type": "number",
+          "description": "Height for chart representation"
+        }
+      },
+      "required": [
+        "width",
+        "height"
+      ],
+      "description": "Size of the chart"
+    },
+    "ChartingRange": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Axis label"
+        },
+        "min": {
+          "type": "number",
+          "description": "Min value",
+          "default": 0
+        },
+        "max": {
+          "type": "number",
+          "description": "Max value",
+          "default": 1
+        },
+        "step": {
+          "type": "number",
+          "description": "Step value; `labelStep` applies when absent"
+        },
+        "labelStep": {
+          "type": "number",
+          "description": "Label step value",
+          "default": 1
+        },
+        "axisLabel": {
+          "type": "string",
+          "description": "Not read by this element: `label` labels the axis"
+        }
+      },
+      "description": "Settings for the value axis"
+    },
+    "ChartingPlaceholderMessages": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Indicates placeholder message if title is not defined"
+        },
+        "labels": {
+          "type": "string",
+          "description": "Indicates placeholder message if labels for range or domain are not defined"
+        }
+      },
+      "description": "Placeholder messages for the chart"
+    },
+    "ExtraCSSRules": {
+      "type": "object",
+      "properties": {
+        "names": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "rules": {
+          "type": "string"
+        }
+      },
+      "description": "Host-supplied CSS scoped to the element: `rules` is a stylesheet whose class names are listed in `names`."
+    }
+  },
+  "additionalProperties": false
+}

package/dist/schemas/session.schema.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/charting@13.0.4/dist/schemas/session.schema.json",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Identifier of the session"
+    },
+    "element": {
+      "type": "string",
+      "description": "The element the session belongs to"
+    },
+    "answer": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/ChartingCategory"
+      },
+      "description": "The student's categories; the initial chart is scored when absent"
+    }
+  },
+  "definitions": {
+    "ChartingCategory": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Indicates category label"
+        },
+        "value": {
+          "type": "number",
+          "description": "Indicates category value"
+        },
+        "interactive": {
+          "type": "boolean",
+          "description": "Indicates if category value is interactive"
+        },
+        "editable": {
+          "type": "boolean",
+          "description": "Indicates if category label is editable"
+        },
+        "deletable": {
+          "type": "boolean",
+          "description": "Indicates if category is deletable"
+        },
+        "index": {
+          "type": "number",
+          "description": "Position of the category in the author's chart; scoring reports it with each correct category"
+        },
+        "correctness": {
+          "$ref": "#/definitions/ChartingCategoryCorrectness",
+          "description": "Indicates correctness for a category"
+        }
+      },
+      "required": [
+        "label",
+        "value"
+      ],
+      "description": "A category on the chart: a bar, a point on a line or a column of a plot"
+    },
+    "ChartingCategoryCorrectness": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "enum": [
+            "correct",
+            "incorrect"
+          ]
+        },
+        "label": {
+          "type": "string",
+          "enum": [
+            "correct",
+            "incorrect"
+          ]
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ],
+      "description": "Whether a category's value or label matches the correct answer; the controller sets it when scoring"
+    }
+  }
+}