@pie-element/inline-dropdown 11.0.5-esm.1 → 11.0.5-next.20261012010413

package/dist/schemas/model.schema.json

@@ -0,0 +1,453 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/inline-dropdown@11.0.5-next.20261012010413/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"
+    },
+    "alternateResponse": {
+      "$ref": "#/definitions/AlternateResponse",
+      "description": "Object that contains values that are right as well, besides the main one"
+    },
+    "alternateResponses": {
+      "$ref": "#/definitions/AlternateResponse",
+      "description": "Not read by this element: `alternateResponse` holds the alternate values"
+    },
+    "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": "Determines if prompt should show"
+    },
+    "lockChoiceOrder": {
+      "type": "boolean",
+      "description": "Indicates if the choices are presented in a fixed order"
+    },
+    "partialScoring": {
+      "type": "boolean",
+      "description": "Indicates if partialScoring is enabled"
+    },
+    "rationale": {
+      "type": "string",
+      "description": "Indicates correct answer rationale"
+    },
+    "scoringType": {
+      "type": "string",
+      "enum": [
+        "auto",
+        "rubric"
+      ],
+      "description": "Not read by this element"
+    },
+    "studentInstructions": {
+      "type": "string",
+      "description": "Not read by this element"
+    },
+    "teacherInstructions": {
+      "type": "string",
+      "description": "Indicates teacher instructions"
+    },
+    "rationaleEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Rationale are enabled"
+    },
+    "spellCheckEnabled": {
+      "type": "boolean",
+      "description": "Indicates if spellcheck is enabled for the author. Default value is true"
+    },
+    "choiceRationaleEnabled": {
+      "type": "boolean",
+      "description": "Indicates if Choice Level Rationales 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"
+    },
+    "displayType": {
+      "type": "string",
+      "description": "Indicates display type for the container of the pie-ui element",
+      "default": "block"
+    },
+    "toolbarEditorPosition": {
+      "type": "string",
+      "enum": [
+        "bottom",
+        "top"
+      ],
+      "description": "Indicates the editor's toolbar position which can be 'bottom' or 'top'",
+      "default": "bottom"
+    },
+    "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"
+    },
+    "extraCSSRules": {
+      "$ref": "#/definitions/ExtraCSSRules",
+      "description": "Host-supplied CSS scoped to the element"
+    },
+    "shuffle": {
+      "type": "boolean",
+      "description": "Not read by this element: `lockChoiceOrder` controls the shuffle. Default models include it."
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Not read: the controller sets `disabled` from the environment. Default models include it."
+    },
+    "mode": {
+      "type": "string",
+      "enum": [
+        "gather",
+        "view",
+        "evaluate"
+      ],
+      "description": "Not read: the controller sets `mode` from the environment. Default models include it."
+    }
+  },
+  "required": [
+    "choices",
+    "element",
+    "id",
+    "markup"
+  ],
+  "description": "Model for the `@pie-element/inline-dropdown`",
+  "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)"
+    },
+    "Choice": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "description": "The value for the choice"
+        },
+        "label": {
+          "type": "string",
+          "description": "The label of the choice"
+        },
+        "correct": {
+          "type": "boolean",
+          "description": "Indicates if choice is correct"
+        },
+        "rationale": {
+          "type": "string",
+          "description": "Rationale for the choice"
+        }
+      },
+      "required": [
+        "value",
+        "label"
+      ],
+      "description": "An option of a response area's dropdown"
+    },
+    "AlternateResponse": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "description": "Further correct choice values for each response area, keyed by the area's index in `markup`"
+    },
+    "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,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cdn.jsdelivr.net/npm/@pie-element/inline-dropdown@11.0.5-next.20261012010413/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"
+    },
+    "value": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "The value of the choice selected in each response area, keyed by the area's index"
+    },
+    "shuffledValues": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Choice values of each response area in the order they were shuffled for this learner, keyed by the area's index, when choice order is not locked. An array is the format of older sessions; the controller replaces it."
+    }
+  },
+  "definitions": {}
+}

package/dist/types.d.ts

@@ -0,0 +1,164 @@
+import type { ConfigureLanguageOptions, ConfigureMathMLProp, ConfigureMaxImageDimensionsProp, ConfigureProp, ConfigurePropWithEnabled, ContentDimensions, EditableHtmlConfigureProp, EditableHtmlPluginConfigure, EditableHtmlPluginConfigureRequired, ExtraCSSRules, PieModel } from '@pie-element/shared-types';
+/** An option of a response area's dropdown */
+export interface Choice {
+    /** The value for the choice */
+    value: string;
+    /** The label of the choice */
+    label: string;
+    /** Indicates if choice is correct */
+    correct?: boolean;
+    /** Rationale for the choice */
+    rationale?: string;
+}
+/**
+ * Object with all the available choices for each response area, keyed by the area's index in `markup`
+ * (0 to n - 1)
+ */
+export type Choices = Record<string, Choice[]>;
+/** Further correct choice values for each response area, keyed by the area's index in `markup` */
+export type AlternateResponse = Record<string, string[]>;
+/**
+ * Model for the `@pie-element/inline-dropdown`
+ */
+export interface InlineDropdownModel extends PieModel {
+    /** Object with all the available choices for each response area */
+    choices: Choices;
+    /** Object that contains values that are right as well, besides the main one */
+    alternateResponse?: AlternateResponse;
+    /** Not read by this element: `alternateResponse` holds the alternate values */
+    alternateResponses?: AlternateResponse;
+    /** The markup for the pie-ui element: response areas are `{{index}}` placeholders */
+    markup: string;
+    /** The authoring editor's markup, with response areas as elements; the author derives `markup` from it */
+    slateMarkup?: string;
+    /** The item stem for the question */
+    prompt?: string;
+    /** Determines if prompt should show */
+    promptEnabled?: boolean;
+    /** Indicates if the choices are presented in a fixed order */
+    lockChoiceOrder?: boolean;
+    /** Indicates if partialScoring is enabled */
+    partialScoring?: boolean;
+    /** Indicates correct answer rationale */
+    rationale?: string;
+    /** Not read by this element */
+    scoringType?: 'auto' | 'rubric';
+    /** Not read by this element */
+    studentInstructions?: string;
+    /** Indicates teacher instructions */
+    teacherInstructions?: string;
+    /** Indicates if Rationale are enabled */
+    rationaleEnabled?: boolean;
+    /** Indicates if spellcheck is enabled for the author. Default value is true */
+    spellCheckEnabled?: boolean;
+    /** Indicates if Choice Level Rationales are enabled */
+    choiceRationaleEnabled?: boolean;
+    /** Not read by this element; default models include it */
+    studentInstructionsEnabled?: boolean;
+    /** Indicates if Teacher Instructions are enabled */
+    teacherInstructionsEnabled?: boolean;
+    /**
+     * Indicates display type for the container of the pie-ui element
+     * @default "block"
+     */
+    displayType?: string;
+    /**
+     * Indicates the editor's toolbar position which can be 'bottom' or 'top'
+     * @default "bottom"
+     */
+    toolbarEditorPosition?: 'bottom' | 'top';
+    /** Indicates if Rubric is enabled */
+    rubricEnabled?: boolean;
+    /**
+     * Indicates the language of the component
+     * Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX
+     */
+    language?: string;
+    /** Host-supplied CSS scoped to the element */
+    extraCSSRules?: ExtraCSSRules;
+    /** Not read by this element: `lockChoiceOrder` controls the shuffle. Default models include it. */
+    shuffle?: boolean;
+    /** Not read: the controller sets `disabled` from the environment. Default models include it. */
+    disabled?: boolean;
+    /** Not read: the controller sets `mode` from the environment. Default models include it. */
+    mode?: 'gather' | 'view' | 'evaluate';
+}
+/**
+ * Config Object for `@pie-element/inline-dropdown`
+ */
+export interface InlineDropdownConfiguration {
+    /**
+     * Base editable html input configuration regarding plugins that are enabled/disabled
+     * E.g. audio, video, image
+     */
+    baseInputConfiguration?: EditableHtmlConfigureProp;
+    /** Not read by this element */
+    choices?: ConfigureProp;
+    /** Item Stem configuration */
+    prompt?: EditableHtmlPluginConfigureRequired;
+    /** Lock Choice Order configuration */
+    lockChoiceOrder?: ConfigureProp;
+    /** Partial Scoring configuration */
+    partialScoring?: ConfigureProp;
+    /** Rationale configuration */
+    rationale?: EditableHtmlPluginConfigureRequired;
+    /** Configuration for the author's spellcheck; `enabled` is not read */
+    spellCheck?: ConfigurePropWithEnabled;
+    /** Choice Level Rationales configuration */
+    choiceRationale?: ConfigureProp;
+    /** Indicates if the settings panel is not available */
+    settingsPanelDisabled?: boolean;
+    /** Not read by this element */
+    scoringType?: ConfigureProp;
+    /** Not read by this element */
+    studentInstructions?: ConfigureProp;
+    /** Teacher Instructions configuration */
+    teacherInstructions?: EditableHtmlPluginConfigureRequired;
+    /** Template configuration */
+    template?: EditableHtmlPluginConfigure;
+    /** Not read by this element; the author's defaults carry it */
+    toolbarEditorPosition?: ConfigureProp;
+    /** Maximum number of response areas */
+    maxResponseAreas?: number;
+    /** Maximum number of choices per response area */
+    maxResponseAreaChoices?: number;
+    /** Maximum image width for input fields */
+    maxImageWidth?: ConfigureMaxImageDimensionsProp;
+    /** Maximum image height for input fields */
+    maxImageHeight?: ConfigureMaxImageDimensionsProp;
+    /** Rubric configuration - only relevant in environments that use pie-player-components */
+    withRubric?: ConfigureProp;
+    /** Configuration for editable-html */
+    mathMlOptions?: ConfigureMathMLProp;
+    /** Language configuration */
+    language?: ConfigurePropWithEnabled;
+    /**
+     * Language choices configuration
+     * Only available if language is enabled
+     */
+    languageChoices?: ConfigureLanguageOptions;
+    /** Configuration for editable-html inside inline-dropdown toolbar, under `inputConfiguration` */
+    responseAreaInputConfiguration?: EditableHtmlPluginConfigure;
+    /** Dimensions of the authoring container */
+    contentDimensions?: ContentDimensions;
+    /** Not read by this element: the model's `promptEnabled` shows the prompt */
+    showPrompt?: boolean;
+    /** Not read by this element: `prompt.label` labels the prompt */
+    promptLabel?: string;
+    /** Not read by this element: `partialScoring.settings` shows the partial scoring control */
+    settingsPartialScoring?: boolean;
+}
+export interface InlineDropdownSession {
+    /** Identifier of the session */
+    id?: string;
+    /** The element the session belongs to */
+    element?: string;
+    /** The value of the choice selected in each response area, keyed by the area's index */
+    value?: Record<string, string>;
+    /**
+     * Choice values of each response area in the order they were shuffled for this learner, keyed by the
+     * area's index, when choice order is not locked. An array is the format of older sessions; the
+     * controller replaces it.
+     */
+    shuffledValues?: Record<string, string[]> | string[];
+}