@citolab/qti-components 7.0.3 → 7.0.5

package/dist/vscode.html-custom-data.json

@@ -416,7 +416,7 @@
     },
     {
       "name": "qti-hottext-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**\n\n### **Methods:**\n ",
       "attributes": [
         { "name": "min-choices", "values": [] },
         { "name": "max-choices", "values": [] },
@@ -450,7 +450,7 @@
     },
     {
       "name": "qti-choice-interaction",
-      "description": "An sample element.\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**\n\n### **Slots:**\n - _default_ - default slot of the choices\n- **prompt** - slot of the prompt\n\n### **CSS Properties:**\n - **--qti-bg-active** - The active background color _(default: #ffecec)_\n- **--qti-border-active** - The active border color _(default: #f86d70)_\n- **--qti-padding-horizontal** - The option horizontal padding _(default: 1px)_\n- **--qti-padding-vertical** - The option vertical padding _(default: solid)_\n- **--qti-border-radius** - The option border radius _(default: 8px)_\n\n### **CSS Parts:**\n - **slot** - The choice elements\n- **prompt** - The prompt\n- **message** - The validation message",
+      "description": "An sample element.\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**\n\n### **Methods:**\n \n\n### **Slots:**\n - _default_ - default slot of the choices\n- **prompt** - slot of the prompt\n\n### **CSS Properties:**\n - **--qti-bg-active** - The active background color _(default: #ffecec)_\n- **--qti-border-active** - The active border color _(default: #f86d70)_\n- **--qti-padding-horizontal** - The option horizontal padding _(default: 1px)_\n- **--qti-padding-vertical** - The option vertical padding _(default: solid)_\n- **--qti-border-radius** - The option border radius _(default: 8px)_\n\n### **CSS Parts:**\n - **slot** - The choice elements\n- **prompt** - The prompt\n- **message** - The validation message",
       "attributes": [
         { "name": "orientation", "values": [{ "name": "Orientation" }] },
         { "name": "class", "values": [] },
@@ -467,6 +467,16 @@
       ],
       "references": []
     },
+    {
+      "name": "qti-upload-interaction",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
+      "attributes": [
+        { "name": "response-identifier", "values": [] },
+        { "name": "disabled", "values": [] },
+        { "name": "readonly", "values": [] }
+      ],
+      "references": []
+    },
     {
       "name": "qti-outcome-processing",
       "description": "\n---\n",
@@ -509,12 +519,12 @@
     },
     {
       "name": "qti-associate-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
       "attributes": [
         { "name": "min-associations", "values": [] },
         { "name": "max-associations", "values": [] },
-        { "name": "disabled", "values": [] },
         { "name": "response-identifier", "values": [] },
+        { "name": "disabled", "values": [] },
         { "name": "readonly", "values": [] }
       ],
       "references": []
@@ -535,24 +545,27 @@
     },
     {
       "name": "qti-end-attempt-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **end-attempt**\n- **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **end-attempt**",
       "attributes": [
-        { "name": "count-attempt", "values": [] },
-        { "name": "title", "values": [{ "name": "end attempt" }] },
         { "name": "response-identifier", "values": [] },
         { "name": "disabled", "values": [] },
-        { "name": "readonly", "values": [] }
+        {
+          "name": "count-attempt",
+          "description": "Defines the number of attempts that a user can make using the 'endAttemptInteraction' mechanism (this can be used to limit the number of hints, etc.). [More information](https://www.imsglobal.org/sites/default/files/spec/qti/v3/info/index.html#DataCharacteristic_EndAttemptInteraction.Attr_count-attempt)",
+          "values": [{ "name": "true" }, { "name": "false" }]
+        },
+        { "name": "title", "values": [] }
       ],
       "references": []
     },
     {
       "name": "qti-gap-match-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
       "attributes": [
         { "name": "min-associations", "values": [] },
         { "name": "max-associations", "values": [] },
-        { "name": "disabled", "values": [] },
         { "name": "response-identifier", "values": [] },
+        { "name": "disabled", "values": [] },
         { "name": "readonly", "values": [] }
       ],
       "references": []
@@ -581,19 +594,19 @@
     },
     {
       "name": "qti-graphic-gap-match-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
       "attributes": [
         { "name": "min-associations", "values": [] },
         { "name": "max-associations", "values": [] },
-        { "name": "disabled", "values": [] },
         { "name": "response-identifier", "values": [] },
+        { "name": "disabled", "values": [] },
         { "name": "readonly", "values": [] }
       ],
       "references": []
     },
     {
       "name": "qti-graphic-order-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**\n\n### **Methods:**\n ",
       "attributes": [
         { "name": "min-choices", "values": [] },
         { "name": "max-choices", "values": [] },
@@ -605,7 +618,7 @@
     },
     {
       "name": "qti-hotspot-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**\n\n### **Methods:**\n ",
       "attributes": [
         { "name": "min-choices", "values": [] },
         { "name": "max-choices", "values": [] },
@@ -617,7 +630,7 @@
     },
     {
       "name": "qti-match-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
       "attributes": [
         { "name": "class", "values": [] },
         { "name": "response-identifier", "values": [] },
@@ -640,7 +653,7 @@
     },
     {
       "name": "qti-order-interaction",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-register-interaction**\n- **qti-interaction-response**",
+      "description": "\n---\n\n\n### **Events:**\n - **qti-interaction-response**\n- **qti-register-interaction**",
       "attributes": [
         {
           "name": "orientation",
@@ -654,8 +667,8 @@
         },
         { "name": "min-associations", "values": [] },
         { "name": "max-associations", "values": [] },
-        { "name": "disabled", "values": [] },
         { "name": "response-identifier", "values": [] },
+        { "name": "disabled", "values": [] },
         { "name": "readonly", "values": [] }
       ],
       "references": []
@@ -686,16 +699,11 @@
     },
     {
       "name": "qti-slider-interaction",
-      "description": "The SliderInteraction.Type (qti-slider-interaction) presents the candidate with a control for selecting a numerical value between a lower and upper bound.\n---\n\n\n### **Events:**\n - **qti-register-interaction** - emitted when the interaction wants to register itself\n- **qti-interaction-response** - emitted when the interaction changes\n\n### **Slots:**\n - _default_ - The default slot where <qti-simple-choice> must be placed.\n- **prompt** - slot where the prompt is placed.\n\n### **CSS Properties:**\n - **--show-value** - shows the current value while sliding _(default: undefined)_\n- **--show-ticks** - shows the ticks according to steps _(default: undefined)_\n- **--show-bounds** - shows value for lower and upper boundary _(default: undefined)_\n\n### **CSS Parts:**\n - **slider** - -- slider inluding, bounds and ticks and value, use it for paddings and margins\n- **bounds** - -- div for bounds, containing two divs for with min, and max bounds value\n- **ticks** - -- div for ticks, use lineair gradient and exposed css variables for styling\n- **rail** - -- div for rail, style according to needs\n- **knob** - -- div, should be relative or absolute\n- **value** - -- div, containing value",
+      "description": "\n---\n\n\n### **Events:**\n - **change**",
       "attributes": [
-        { "name": "step-label", "values": [] },
-        { "name": "reverse", "values": [] },
         { "name": "lower-bound", "values": [] },
         { "name": "upper-bound", "values": [] },
-        { "name": "step", "values": [] },
-        { "name": "response-identifier", "values": [] },
-        { "name": "disabled", "values": [] },
-        { "name": "readonly", "values": [] }
+        { "name": "step", "values": [] }
       ],
       "references": []
     },
@@ -799,6 +807,24 @@
       ],
       "references": []
     },
+    {
+      "name": "qti-item",
+      "description": "`<qti-item>` is a custom element designed for rendering a single `qti-assessment-item`.\nIt can also host some functionalities to interact with the item like scoring, showing feedback, etc.\nPlacing a mandatory `<item-container>` inside '<qti-item>' will load or parse the item and render it.\nSee `<item-container>` for more details.\n\n```html\n<qti-item>\n  <item-container class=\"m-4 bg-white\" item-url=\"./path/to/item.xml\"></item-container>\n</qti-item>\n```\n---\n",
+      "attributes": [],
+      "references": []
+    },
+    {
+      "name": "item-container",
+      "description": "`<item-container>` is a custom element designed for hosting the qti-assessment-item.\nThe `qti-assessment-item` will be placed inside the shadow DOM of this element.\nThe element loads the item from the provided URL and renders it inside the shadow DOM.\n\n### Styling\nAdd a class to the element for styling.\n\n```html\n<qti-item>\n  <item-container class=\"m-4 bg-white\" item-url=\"./path/to/item.xml\"></item-container>\n</qti-item>\n```\n---\n",
+      "attributes": [
+        {
+          "name": "item-url",
+          "description": "URL of the item to load",
+          "values": []
+        }
+      ],
+      "references": []
+    },
     {
       "name": "qti-assessment-item-ref",
       "description": "\n---\n\n\n### **Events:**\n - **qti-assessment-item-ref-connected**",
@@ -853,14 +879,8 @@
     },
     {
       "name": "qti-test",
-      "description": "`<qti-test>` is a custom element designed for rendering and interacting with QTI (Question and Test Interoperability) tests.\n\nThis component leverages several mixins to provide functionality for loading, navigating, processing, and displaying QTI test assessments.\n\n### Example Usage\n\nMinimal markup:\n```html\n<qti-test test=\"./path/to/assessment.xml\">\n  <test-container></test-container>\n</qti-test>\n```\n\nWith navigation buttons:\n```html\n<qti-test >\n  <test-container test-url=\"./path/to/assessment.xml\"></test-container>\n  <div class=\"flex\">\n     <test-prev></test-prev>\n     <test-next></test-next>\n  </div>\n</qti-test>\n```\n\nYou can use normal class names to style the elements.\nAnd you can use the `test-prev` and `test-next` elements to navigate through the test.\n---\n",
-      "attributes": [
-        {
-          "name": "testURL",
-          "description": "the relative location to the QTI assessment.xml file ### Features - **Dynamic Template Loading**: If a `<template>` element is included as a child of `<qti-test>`, its content is dynamically appended to the shadow DOM.",
-          "values": []
-        }
-      ],
+      "description": "`<qti-test>` is a custom element designed for rendering and interacting with QTI (Question and Test Interoperability) tests.\n\nThis component leverages several mixins to provide functionality for loading, navigating, processing, and displaying QTI test assessments.\n\n### Example Usage\n\nMinimal example including navigation:\n\n```html\n<qti-test>\n  <test-container test-url=\"./path/to/assessment.xml\"></test-container>\n  <nav class=\"flex\">\n     <test-prev></test-prev>\n     <test-next></test-next>\n  </nav>\n</qti-test>\n```\n\nUse the following file structure\nA qti-test loads a QTI3.0 assessmenttest.xml file from a package folder.\n\n```plaintext\nRoot/\n├── index.html\n└── /assets/api/examples/\n    ├── assessmenttest.xml\n    └── imsmanifest.xml\n\n```\n\n### Test components\n\nUse test components inside the qti-test component for added functionality.\n### Test next\n`<test-next> | TestNext`\n\n### Test prev\n\n`<test-prev> | TestPrev`\n### Test components\n\nYou can use normal class names to style the elements.\nAnd you can use the `test-prev` and `test-next` elements to navigate through the test.\n---\n",
+      "attributes": [],
       "references": []
     },
     {
@@ -879,8 +899,16 @@
       "name": "test-view",
       "description": "\n---\n\n\n### **Events:**\n - **on-test-switch-view**\n- **qti-request-test-item**",
       "attributes": [
-        { "name": "label", "values": [] },
-        { "name": "view-options", "values": [] }
+        {
+          "name": "label",
+          "description": "label accompanying the select view dropdown",
+          "values": []
+        },
+        {
+          "name": "view-options",
+          "description": "The options to display in the dropdown, default: ['author', 'candidate', 'proctor', 'scorer', 'testConstructor', 'tutor']",
+          "values": []
+        }
       ],
       "references": []
     },
@@ -892,8 +920,14 @@
     },
     {
       "name": "test-container",
-      "description": "`<test-container>` is a custom element designed for hosting the qti-assessment-test.\nThe `qti-assessment-test` will be placed inside the shadow DOM of this element.\n\n### Example Usage\nThe `test-container` element to hosts the visual representation of the items.\nYou can style the container by adding a class to the element.\n\n```html\n<qti-test testurl=\"./path/to/assessment.xml\">\n  <test-container class=\"container bg-white m-2\"></test-container>\n</qti-test>\n```\n---\n",
-      "attributes": [{ "name": "test-url", "values": [] }],
+      "description": "`<test-container>` is a custom element designed for hosting the qti-assessment-item.\nThe `qti-assessment-test` will be placed inside the shadow DOM of this element.\nThe element loads the test from the provided URL and renders it inside the shadow DOM.\n\n```html\n<qti-test>\n  <test-container class=\"m-4 bg-white\" test-url=\"./path/to/assessmenttest.xml\"></test-container>\n</qti-test>\n```\n---\n",
+      "attributes": [
+        {
+          "name": "test-url",
+          "description": "URL of the item to load",
+          "values": []
+        }
+      ],
       "references": []
     },
     {
@@ -904,15 +938,6 @@
         { "name": "skip-on-category", "values": [] }
       ],
       "references": []
-    },
-    {
-      "name": "qti-item",
-      "description": "\n---\n\n\n### **Events:**\n - **qti-item-connected**",
-      "attributes": [
-        { "name": "identifier", "values": [] },
-        { "name": "href", "values": [] }
-      ],
-      "references": []
     }
   ]
 }

package/package.json

@@ -21,37 +21,23 @@
   "engines": {
     "node": ">=20.0.0"
   },
-  "version": "7.0.3",
-  "main": "dist/index.js",
+  "version": "7.0.5",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./transformers": {
-      "import": "./dist/transformers/index.js"
-    },
-    "./loader": {
-      "import": "./dist/loader/index.js"
-    },
-    "./item.css": "./dist/item.css",
-    "./cdn/index.js": "./cdn/index.js",
-    "./cdn/index.global.js": "./cdn/index.global.js",
-    "./react": "./dist//qti-components-jsx.d.ts"
-  },
-  "types": "./dist/qti-components/index.d.ts",
-  "typesVersions": {
-    "*": {
-      ".": [
-        "./dist/index.d.ts"
-      ],
-      "transformers": [
-        "./dist/transformers/index.d.ts"
-      ],
-      "loader": [
-        "./dist/loader/index.d.ts"
-      ]
-    }
+    "./qti-components": "./dist/qti-components/index.js",
+    "./qti-components/*": "./dist/qti-components/*",
+    "./qti-test": "./dist/qti-test/index.js",
+    "./qti-test/*": "./dist/qti-test/*",
+    "./qti-item": "./dist/qti-test/index.js",
+    "./qti-item/*": "./dist/qti-item/*",
+    "./loader": "./dist/qti-loader/index.js",
+    "./transformers": "./dist/qti-transformers/index.js",
+    "./react": "./dist/qti-components-jsx.d.ts",
+    "./item.css": "./dist/item.css"
   },
   "files": [
     "dist",
@@ -73,7 +59,7 @@
     "vite": "vite",
     "stylelint": "stylelint \"src/**/*.css\"",
     "build-storybook": "storybook build",
-    "storybook:test": "test-storybook",
+    "test-storybook": "wireit",
     "storybook:docs:build": "wireit",
     "chromatic": "node chromatic-runner.cjs",
     "----hooks----": "-",
@@ -88,33 +74,26 @@
       ]
     },
     "build": {
-      "env": {
-        "NODE_ENV": "production"
-      },
       "command": "tsup",
       "dependencies": [
         "cem",
         "css"
       ],
       "files": [
-        "src/**/*.{ts}",
+        "src/**/*.ts",
         "tsconfig.json",
-        "!src/**/*.{test,spec,stories}.ts",
-        "package.json"
+        "package.json",
+        "tsup.config.ts"
       ]
     },
     "cem": {
-      "command": "cem analyze",
-      "files": [
-        "src/**/*.ts",
-        "!src/**/*.{test,spec,stories}.ts"
-      ]
+      "command": "cem analyze"
+    },
+    "test-storybook": {
+      "command": "test-storybook --excludeTags no-tests"
     },
     "css": {
-      "command": "postcss src/item.css -d dist -m",
-      "files": [
-        "src/**/*.css"
-      ]
+      "command": "postcss src/item.css -d dist -m"
     },
     "test": {
       "command": "vitest run",
@@ -143,23 +122,21 @@
       }
     },
     "attw": {
-      "command": "attw --profile esm-only --pack --exclude-entrypoints  ./item.css ./cdn/index.js ./cdn/index.global.js ./cdn/index.min.js",
+      "command": "attw --profile esm-only --pack --exclude-entrypoints  ./item.css",
       "dependencies": [
         "build"
       ]
     }
   },
+  "dependencies": {},
   "peerDependencies": {
-    "@lit/context": "^1.1.2",
-    "lit": "^3.2.1",
-    "stampino": "^0.8.3"
-  },
-  "dependencies": {
-    "@lit/context": "^1.1.2",
+    "@lit/context": "^1.1.3",
     "lit": "^3.2.1",
     "stampino": "^0.8.3"
   },
   "devDependencies": {
+    "lit": "^3.2.1",
+    "stampino": "^0.8.3",
     "@arethetypeswrong/cli": "^0.17.1",
     "@chromatic-com/storybook": "^3.2.2",
     "@commitlint/cli": "^19.6.0",
@@ -175,7 +152,7 @@
     "@storybook/blocks": "^8.4.7",
     "@storybook/preview-api": "^8.4.7",
     "@storybook/test": "^8.4.7",
-    "@storybook/test-runner": "^0.20.1",
+    "@storybook/test-runner": "^0.21.0",
     "@storybook/web-components": "^8.4.7",
     "@storybook/web-components-vite": "^8.4.7",
     "@swc/core": "^1.10.1",
@@ -186,6 +163,7 @@
     "@typescript-eslint/parser": "^8.17.0",
     "@vitest/browser": "^2.1.8",
     "autoprefixer": "^10.4.20",
+    "globby": "^14.0.2",
     "cem-plugin-expanded-types": "^1.3.3",
     "chromatic": "^11.20.0",
     "custom-element-eslint-rule-generator": "^1.0.1",
@@ -206,7 +184,6 @@
     "globals": "^15.13.0",
     "husky": "^9.1.7",
     "np": "^10.1.0",
-    "npm": "^10.9.2",
     "path-browserify": "^1.0.1",
     "pkg-pr-new": "^0.0.37",
     "playwright": "^1.49.0",
@@ -219,6 +196,7 @@
     "remark-gfm": "^4.0.0",
     "shadow-dom-testing-library": "^1.11.3",
     "storybook": "^8.4.7",
+    "storybook-addon-tag-badges": "^1.3.2",
     "stylelint": "^16.11.0",
     "stylelint-config-standard": "^36.0.1",
     "stylelint-prettier": "^5.0.2",