@timeback/qti 0.2.0 → 0.2.1-beta.20260313210405

package/dist/parse.d.ts

@@ -0,0 +1,124 @@
+/**
+ * QTI Parse Types
+ *
+ * Type definitions for QTI XML parsing utilities.
+ */
+/** A single choice option extracted from a `<qti-simple-choice>` element. */
+interface QtiChoice {
+    identifier: string;
+    text: string;
+}
+/** Inline feedback extracted from a `<qti-feedback-inline>` element. */
+interface QtiInlineFeedback {
+    outcomeIdentifier: string;
+    identifier: string;
+    showHide: string;
+    content: string;
+}
+/** Modal feedback extracted from a `<qti-modal-feedback>` element. */
+interface QtiModalFeedback {
+    outcomeIdentifier: string;
+    identifier: string;
+    showHide: string;
+    content: string;
+}
+/** Attributes from a `<qti-choice-interaction>` element. */
+interface QtiInteractionAttributes {
+    responseIdentifier: string;
+    shuffle: boolean;
+    maxChoices: number;
+}
+/** Response declaration extracted from a `<qti-response-declaration>` element. */
+interface QtiResponseDeclaration {
+    identifier: string;
+    cardinality: string;
+    baseType: string | null;
+}
+/** Complete parsed result from a QTI assessment item XML string. */
+interface ParsedQtiItem {
+    prompt: string;
+    choices: QtiChoice[];
+    correctAnswer: string | null;
+    feedback: QtiInlineFeedback[];
+    modalFeedback: QtiModalFeedback[];
+    interaction: QtiInteractionAttributes | null;
+    responseDeclaration: QtiResponseDeclaration | null;
+}
+
+/**
+ * Extract the prompt text from a `<qti-prompt>` element.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns The inner HTML of the prompt, or an empty string if not found
+ */
+declare function extractPrompt(xml: string): string;
+/**
+ * Extract simple choices from `<qti-simple-choice>` elements.
+ *
+ * Inline feedback elements within each choice are stripped from the returned
+ * text. Use {@link extractFeedback} to retrieve them separately.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Array of choices with identifier and cleaned text
+ */
+declare function extractChoices(xml: string): QtiChoice[];
+/**
+ * Extract the correct answer identifier from `<qti-correct-response>`.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns The correct answer identifier, or null if not found
+ */
+declare function extractCorrectResponse(xml: string): string | null;
+/**
+ * Extract inline feedback from `<qti-feedback-inline>` elements.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Array of inline feedback entries
+ */
+declare function extractFeedback(xml: string): QtiInlineFeedback[];
+/**
+ * Extract modal feedback from `<qti-modal-feedback>` elements.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Array of modal feedback entries
+ */
+declare function extractModalFeedback(xml: string): QtiModalFeedback[];
+/**
+ * Extract interaction attributes from `<qti-choice-interaction>`.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Interaction attributes, or null if no choice interaction found
+ */
+declare function extractInteractionAttributes(xml: string): QtiInteractionAttributes | null;
+/**
+ * Extract the response declaration from `<qti-response-declaration>`.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Response declaration, or null if not found
+ */
+declare function extractResponseDeclaration(xml: string): QtiResponseDeclaration | null;
+/**
+ * Parse a QTI 3.0 assessment item XML string into structured data.
+ *
+ * Combines all individual extractors into a single result. For more control,
+ * use the individual `extract*` functions directly.
+ *
+ * @param xml - Raw QTI XML string
+ * @returns Complete parsed item data
+ *
+ * @example
+ * ```typescript
+ * import { parseQtiXml } from '@timeback/qti/parse'
+ *
+ * const item = parseQtiXml(xml)
+ * console.log(item.prompt)            // "What is 2 + 2?"
+ * console.log(item.choices)           // [{ identifier: "A", text: "3" }, ...]
+ * console.log(item.correctAnswer)     // "B"
+ * console.log(item.feedback)          // [{ identifier: "A", content: "..." }, ...]
+ * console.log(item.modalFeedback)     // [{ identifier: "CORRECT", content: "..." }, ...]
+ * ```
+ */
+declare function parseQtiXml(xml: string): ParsedQtiItem;
+
+export { extractChoices, extractCorrectResponse, extractFeedback, extractInteractionAttributes, extractModalFeedback, extractPrompt, extractResponseDeclaration, parseQtiXml };
+export type { ParsedQtiItem, QtiChoice, QtiInlineFeedback, QtiInteractionAttributes, QtiModalFeedback, QtiResponseDeclaration };

package/dist/parse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../src/parse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,eAAe,CAAA;AAEtB;;;;;;;;;;;;;;GAcG;AAEH,YAAY,EACX,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACtB,MAAM,eAAe,CAAA;AAMtB;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAKjD;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,CAevD;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKjE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAsBhE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,EAAE,CA4BpE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,IAAI,CAiBzF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI,CAiBrF;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAUtD"}

package/dist/parse.js

@@ -0,0 +1,126 @@
+import"./chunk-6jf1natv.js";
+
+// src/parse.ts
+function extractPrompt(xml) {
+  if (!xml)
+    return "";
+  const match = xml.match(/<qti-prompt[^>]*>([\s\S]*?)<\/qti-prompt>/i);
+  return match?.[1]?.trim() ?? "";
+}
+function extractChoices(xml) {
+  if (!xml)
+    return [];
+  const choices = [];
+  const regex = /<qti-simple-choice[^>]*identifier="([^"]+)"[^>]*>([\s\S]*?)<\/qti-simple-choice>/gi;
+  let match;
+  while ((match = regex.exec(xml)) !== null) {
+    let text = match[2] ?? "";
+    text = text.replace(/<qti-feedback-inline[\s\S]*?<\/qti-feedback-inline>/gi, "").trim();
+    choices.push({ identifier: match[1] ?? "", text });
+  }
+  return choices;
+}
+function extractCorrectResponse(xml) {
+  if (!xml)
+    return null;
+  const match = xml.match(/<qti-correct-response>\s*<qti-value>([^<]+)<\/qti-value>/i);
+  return match?.[1]?.trim() ?? null;
+}
+function extractFeedback(xml) {
+  if (!xml)
+    return [];
+  const feedback = [];
+  const regex = /<qti-feedback-inline([^>]*)>([\s\S]*?)<\/qti-feedback-inline>/gi;
+  let match;
+  while ((match = regex.exec(xml)) !== null) {
+    const attrs = match[1] ?? "";
+    const outcomeId = attrs.match(/outcome-identifier="([^"]*)"/);
+    const id = attrs.match(/(?:^|\s)identifier="([^"]*)"/);
+    const showHide = attrs.match(/show-hide="([^"]*)"/);
+    feedback.push({
+      outcomeIdentifier: outcomeId?.[1] ?? "",
+      identifier: id?.[1] ?? "",
+      showHide: showHide?.[1] ?? "show",
+      content: (match[2] ?? "").trim()
+    });
+  }
+  return feedback;
+}
+function extractModalFeedback(xml) {
+  if (!xml)
+    return [];
+  const modalFeedback = [];
+  const regex = /<qti-modal-feedback([^>]*)>([\s\S]*?)<\/qti-modal-feedback>/gi;
+  let match;
+  while ((match = regex.exec(xml)) !== null) {
+    const attrs = match[1] ?? "";
+    const outcomeId = attrs.match(/outcome-identifier="([^"]*)"/);
+    const id = attrs.match(/(?:^|\s)identifier="([^"]*)"/);
+    const showHide = attrs.match(/show-hide="([^"]*)"/);
+    let content = match[2] ?? "";
+    const bodyMatch = content.match(/<qti-content-body>([\s\S]*?)<\/qti-content-body>/i);
+    if (bodyMatch) {
+      content = bodyMatch[1] ?? "";
+    }
+    modalFeedback.push({
+      outcomeIdentifier: outcomeId?.[1] ?? "",
+      identifier: id?.[1] ?? "",
+      showHide: showHide?.[1] ?? "show",
+      content: content.trim()
+    });
+  }
+  return modalFeedback;
+}
+function extractInteractionAttributes(xml) {
+  if (!xml)
+    return null;
+  const match = xml.match(/<qti-choice-interaction([^>]*)>/i);
+  if (!match)
+    return null;
+  const attrs = match[1] ?? "";
+  const responseId = attrs.match(/response-identifier="([^"]*)"/);
+  const shuffle = attrs.match(/shuffle="([^"]*)"/);
+  const maxChoices = attrs.match(/max-choices="([^"]*)"/);
+  return {
+    responseIdentifier: responseId?.[1] ?? "",
+    shuffle: shuffle?.[1]?.toLowerCase() === "true",
+    maxChoices: maxChoices?.[1] ? parseInt(maxChoices[1], 10) : 1
+  };
+}
+function extractResponseDeclaration(xml) {
+  if (!xml)
+    return null;
+  const match = xml.match(/<qti-response-declaration([^>]*)>/i);
+  if (!match)
+    return null;
+  const attrs = match[1] ?? "";
+  const identifier = attrs.match(/identifier="([^"]*)"/);
+  const cardinality = attrs.match(/cardinality="([^"]*)"/);
+  const baseType = attrs.match(/base-type="([^"]*)"/);
+  return {
+    identifier: identifier?.[1] ?? "",
+    cardinality: cardinality?.[1] ?? "",
+    baseType: baseType?.[1] ?? null
+  };
+}
+function parseQtiXml(xml) {
+  return {
+    prompt: extractPrompt(xml),
+    choices: extractChoices(xml),
+    correctAnswer: extractCorrectResponse(xml),
+    feedback: extractFeedback(xml),
+    modalFeedback: extractModalFeedback(xml),
+    interaction: extractInteractionAttributes(xml),
+    responseDeclaration: extractResponseDeclaration(xml)
+  };
+}
+export {
+  parseQtiXml,
+  extractResponseDeclaration,
+  extractPrompt,
+  extractModalFeedback,
+  extractInteractionAttributes,
+  extractFeedback,
+  extractCorrectResponse,
+  extractChoices
+};

package/dist/parse.types.d.ts

@@ -0,0 +1,47 @@
+/**
+ * QTI Parse Types
+ *
+ * Type definitions for QTI XML parsing utilities.
+ */
+/** A single choice option extracted from a `<qti-simple-choice>` element. */
+export interface QtiChoice {
+    identifier: string;
+    text: string;
+}
+/** Inline feedback extracted from a `<qti-feedback-inline>` element. */
+export interface QtiInlineFeedback {
+    outcomeIdentifier: string;
+    identifier: string;
+    showHide: string;
+    content: string;
+}
+/** Modal feedback extracted from a `<qti-modal-feedback>` element. */
+export interface QtiModalFeedback {
+    outcomeIdentifier: string;
+    identifier: string;
+    showHide: string;
+    content: string;
+}
+/** Attributes from a `<qti-choice-interaction>` element. */
+export interface QtiInteractionAttributes {
+    responseIdentifier: string;
+    shuffle: boolean;
+    maxChoices: number;
+}
+/** Response declaration extracted from a `<qti-response-declaration>` element. */
+export interface QtiResponseDeclaration {
+    identifier: string;
+    cardinality: string;
+    baseType: string | null;
+}
+/** Complete parsed result from a QTI assessment item XML string. */
+export interface ParsedQtiItem {
+    prompt: string;
+    choices: QtiChoice[];
+    correctAnswer: string | null;
+    feedback: QtiInlineFeedback[];
+    modalFeedback: QtiModalFeedback[];
+    interaction: QtiInteractionAttributes | null;
+    responseDeclaration: QtiResponseDeclaration | null;
+}
+//# sourceMappingURL=parse.types.d.ts.map

package/dist/parse.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.types.d.ts","sourceRoot":"","sources":["../src/parse.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6EAA6E;AAC7E,MAAM,WAAW,SAAS;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACZ;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IACjC,iBAAiB,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CACf;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAChC,iBAAiB,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CACf;AAED,4DAA4D;AAC5D,MAAM,WAAW,wBAAwB;IACxC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CAClB;AAED,kFAAkF;AAClF,MAAM,WAAW,sBAAsB;IACtC,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,oEAAoE;AACpE,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,SAAS,EAAE,CAAA;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,aAAa,EAAE,gBAAgB,EAAE,CAAA;IACjC,WAAW,EAAE,wBAAwB,GAAG,IAAI,CAAA;IAC5C,mBAAmB,EAAE,sBAAsB,GAAG,IAAI,CAAA;CAClD"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@timeback/qti",
-	"version": "0.2.0",
+	"version": "0.2.1-beta.20260313210405",
 	"type": "module",
 	"exports": {
 		".": {
@@ -17,6 +17,11 @@
 			"source": "./src/public-types.ts",
 			"types": "./dist/public-types.d.ts",
 			"import": "./dist/public-types.js"
+		},
+		"./parse": {
+			"source": "./src/parse.ts",
+			"types": "./dist/parse.d.ts",
+			"import": "./dist/parse.js"
 		}
 	},
 	"main": "dist/index.js",