{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/explicit-constructed-response@12.1.1/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`"
    },
    "choices": {
      "$ref": "#/definitions/Choices",
      "description": "Object with all the available choices for each response area"
    },
    "displayType": {
      "type": "string",
      "description": "The type of display the container of the pie-ui element will be used",
      "default": "block"
    },
    "markup": {
      "type": "string",
      "description": "The markup for the pie-ui element: response areas are `{{index}}` placeholders"
    },
    "slateMarkup": {
      "type": "string",
      "description": "The authoring editor's markup, with response areas as elements; the author derives `markup` from it"
    },
    "prompt": {
      "type": "string",
      "description": "The item stem for the question"
    },
    "promptEnabled": {
      "type": "boolean",
      "description": "Indicates if the prompt is enabled"
    },
    "spellCheckEnabled": {
      "type": "boolean",
      "description": "Indicates if spellcheck is enabled for the author",
      "default": true
    },
    "playerSpellCheckEnabled": {
      "type": "boolean",
      "description": "Indicates if spellcheck is enabled for the player",
      "default": false
    },
    "rationale": {
      "type": "string",
      "description": "Indicates correct answer rationale"
    },
    "autoScoring": {
      "type": "string",
      "enum": [
        "allOrNothing",
        "partial"
      ],
      "description": "Not read by this element: `partialScoring` selects the scoring"
    },
    "partialScoring": {
      "type": "boolean",
      "description": "Indicates that the item should use partial scoring"
    },
    "studentInstructions": {
      "type": "string",
      "description": "Not read by this element"
    },
    "teacherInstructions": {
      "type": "string",
      "description": "Indicates teacher instructions"
    },
    "rubric": {
      "type": "string",
      "description": "Not read by this element"
    },
    "rationaleEnabled": {
      "type": "boolean",
      "description": "Indicates if Rationale are enabled"
    },
    "studentInstructionsEnabled": {
      "type": "boolean",
      "description": "Not read by this element; default models include it"
    },
    "teacherInstructionsEnabled": {
      "type": "boolean",
      "description": "Indicates if Teacher Instructions are enabled"
    },
    "note": {
      "type": "string",
      "description": "Indicates the note for the answer; the element shows a translated default when it is absent"
    },
    "toolbarEditorPosition": {
      "type": "string",
      "enum": [
        "bottom",
        "top"
      ],
      "description": "Indicates the editor's toolbar position which can be 'bottom' or 'top'",
      "default": "bottom"
    },
    "maxLengthPerChoice": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Indicates the maximum length for each response area"
    },
    "maxLengthPerChoiceEnabled": {
      "type": "boolean",
      "description": "Indicates if each response area's input is limited to its `maxLengthPerChoice`",
      "default": true
    },
    "rubricEnabled": {
      "type": "boolean",
      "description": "Indicates if Rubric is enabled"
    },
    "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"
    },
    "spanishInputEnabled": {
      "type": "boolean",
      "description": "Not read by this element: `responseAreaInputConfiguration.characters` controls the Spanish characters"
    },
    "responseAreaInputConfiguration": {
      "$ref": "#/definitions/EditableHtmlConfigureProp",
      "description": "Toolbar plugins of the response areas' inputs; the author copies them from the configuration's `responseAreaInputConfiguration.inputConfiguration`"
    },
    "defaultFeedback": {
      "type": "object",
      "properties": {
        "correct": {
          "type": "string"
        },
        "incorrect": {
          "type": "string"
        }
      },
      "description": "Feedback texts that choices with `default` feedback show"
    },
    "extraCSSRules": {
      "$ref": "#/definitions/ExtraCSSRules",
      "description": "Host-supplied CSS scoped to the element"
    },
    "disabled": {
      "type": "boolean",
      "description": "Not read: the controller sets `disabled` from the environment. Demo models include it."
    }
  },
  "required": [
    "choices",
    "element",
    "id",
    "markup"
  ],
  "description": "Model for the `@pie-element/explicit-constructed-response`",
  "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."
    },
    "Choices": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/Choice"
        }
      },
      "description": "Object with all the available choices for each response area, keyed by the area's index in `markup` (0 to n - 1). The first choice is the correct answer; the others are its alternates."
    },
    "Choice": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "The value for the choice"
        },
        "label": {
          "type": "string",
          "description": "The label of the choice: the answer the learner types"
        },
        "feedback": {
          "$ref": "#/definitions/ChoiceFeedback",
          "description": "Feedback for the choice when the response is evaluated"
        }
      },
      "required": [
        "value",
        "label"
      ],
      "description": "An accepted answer for a response area"
    },
    "ChoiceFeedback": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "none",
            "default",
            "custom"
          ],
          "description": "`default` shows the model's `defaultFeedback.correct`, `custom` shows `value`; absent means `none`"
        },
        "value": {
          "type": "string",
          "description": "The custom feedback"
        }
      },
      "description": "Feedback for a choice, shown when the response is evaluated"
    },
    "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"
      ]
    },
    "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
}