@citolab/tspci 2.5.30-beta.4 → 2.5.30-beta.5

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.5.30-beta.5](/compare/v2.5.30-beta.4...v2.5.30-beta.5) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
 ## [2.5.30-beta.4](/compare/v2.5.30-beta.3...v2.5.30-beta.4) (2025-02-03)
 
 **Note:** Version bump only for package @citolab/tspci

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci",
-  "version": "2.5.30-beta.4",
+  "version": "2.5.30-beta.5",
   "description": "an opiniated typescript ims-pci builder with tao integration",
   "author": "patrick <patrick.deklein@cito.nl>",
   "repository": "@citolab/tspci",
@@ -50,5 +50,5 @@
   "resolutions": {
     "chokidar": "^4.0.0"
   },
-  "gitHead": "8b22951f33e93e15da089e977a426bbc4846273d"
+  "gitHead": "b9e35ba31c83b085f3a836adef7ccdf6fa7ed53a"
 }

package/preset/javascript/src/index.js

@@ -41,8 +41,17 @@ class Pci {
 
     this.shadowdom = dom.attachShadow({ mode: "closed" });
     this.render();
-
-    config.onready(this);
+    const event = {
+      interaction: this,
+      responseIdentifier: this.config.responseIdentifier,
+      valid: true,
+      value: this.getResponse(),
+    };
+    // dispatch a custom event to notify the Delivery System that the interaction has changed
+    const interactionChangedEvent = new CustomEvent("qtiInteractionChanged", {
+      detail: event,
+    });
+    this.shadowdom.dispatchEvent(interactionChangedEvent);
   };
 
   render = () => {

package/preset/preact/src/index.tsx

@@ -20,7 +20,9 @@ class App implements IMSpci<PropTypes> {
   private logActions: { type: string; payload: unknown }[] = []; // optional logActions
   private initialState: StateModel = { input: undefined }; // optional initial state
   constructor() {
-    ctx && ctx.register(this);
+    if (ctx) {
+      ctx.register(this);
+    }
   }
 
   getInstance = (dom: HTMLElement, config: Configuration<PropTypes>, stateString: string) => {
@@ -41,7 +43,9 @@ class App implements IMSpci<PropTypes> {
     this.shadowdom = dom.attachShadow({ mode: "closed" });
     this.render();
 
-    this.config.onready && this.config.onready(this);
+    if (this.config.onready) {
+      this.config.onready(this);
+    }
   };
 
   render = () => {

package/preset/preact/src/store.ts

@@ -1,15 +1,19 @@
 import { Store } from "@citolab/preact-store";
 
 export type ActionType = "SET_INPUT" | "RESTORE_STATE";
-export type StateModel = { input: number };
+export type StateModel = { input: number | undefined };
 
-export const initStore = (initialState: StateModel, restoreData?: {
-  state?: StateModel;
-  actions: { type: string; payload: any; timestamp?: number }[];
-}) => {
+export const initStore = (
+  initialState: StateModel,
+  restoreData?: {
+    state: StateModel;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    actions: { type: string; payload: any; timestamp?: number }[];
+  }
+) => {
   const store = new Store<StateModel>(initialState, restoreData);
-  store.addReducer<{ input: number }>("SET_INPUT", (state, { input }) => {
-    return {...state, input };
+  store.addReducer<{ input: number | undefined }>("SET_INPUT", (state, { input }) => {
+    return { ...state, input };
   });
   return store;
-}
+};

package/preset/typescript/src/index.ts

@@ -15,7 +15,9 @@ class Pci implements IMSpci<PropTypes> {
   shadowdom: ShadowRoot | Element; // Not mandatory, but its wise to create a shadowroot
 
   constructor() {
-    ctx && ctx.register(this); // we assume the qtiCustomInteractionContext is avaible due to the import above
+    if (ctx) {
+      ctx.register(this); // we assume the qtiCustomInteractionContext is avaible due to the import above
+    }
   }
 
   // First in the lifecycle of a PCI, this method is called with the domElement ( usually qti-interaction-markup ) where we can add our dom tree.

package/types/index.d.ts

@@ -1,6 +1,6 @@
 // Define the payload structure for the custom event
 export interface QtiInteractionChangedDetail {
-  interaction: IMSpci<ConfigProperties<unknown>>; // The PCI instance itself
+  interaction: IMSpci<unknown>; // The PCI instance itself
   responseIdentifier: string; // The response identifier provided in the getInstance call
   valid?: boolean; // Optional boolean indicating if checkValidity() returns true
   value?: QtiVariableJSON; // Optional value returned by getResponse()
@@ -14,9 +14,9 @@ export interface ConfigProperties<T> {
   boundTo: Record<string, QtiVariableJSON>; // Follows structure in Appendix C
   responseIdentifier: string; // Unique within interaction scope
 
-  onready: (interaction: IMSpci<ConfigProperties<unknown>>, state?: string) => void; // Callback when PCI is fully constructed and ready
+  onready: (interaction: IMSpci<T>, state?: string) => void; // Callback when PCI is fully constructed and ready
   ondone?: (
-    interaction: IMSpci<ConfigProperties<unknown>>,
+    interaction: IMSpci<T>,
     response: Record<string, QtiVariableJSON>,
     state: string,
     status?: "interacting" | "closed" | "solution" | "review"