@citolab/tspci 2.5.22 → 2.5.30-beta.0

package/CHANGELOG.md

@@ -3,6 +3,70 @@
 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.0](/compare/v2.5.29...v2.5.30-beta.0) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## 2.5.29 (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## [2.5.28](/compare/v2.5.27...v2.5.28) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## [2.5.27](/compare/v2.5.26...v2.5.27) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## [2.5.26](/compare/v2.5.25...v2.5.26) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## [2.5.25](/compare/v2.5.24...v2.5.25) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## [2.5.24](/compare/v2.5.23...v2.5.24) (2025-02-03)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
+## 2.5.23 (2024-10-16)
+
+**Note:** Version bump only for package @citolab/tspci
+
+
+
+
+
 ## 2.5.22 (2024-10-16)
 
 **Note:** Version bump only for package @citolab/tspci

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci",
-  "version": "2.5.22",
+  "version": "2.5.30-beta.0",
   "description": "an opiniated typescript ims-pci builder with tao integration",
   "author": "patrick <patrick.deklein@cito.nl>",
   "repository": "@citolab/tspci",
@@ -37,7 +37,7 @@
     "live-server": "^1.2.2",
     "postcss": "^8.4.47",
     "postcss-import": "^16.1.0",
-    "rollup": "^4.24.0",
+    "rollup": "^4.34.1",
     "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-live-server": "^2.0.0",
     "rollup-plugin-livereload": "^2.0.5",
@@ -45,10 +45,10 @@
     "rollup-plugin-node-globals": "^1.4.0",
     "rollup-plugin-postcss": "^4.0.2",
     "rollup-plugin-string": "^3.0.0",
-    "tailwindcss": "^3.4.11"
+    "tailwindcss": "^4.0.3"
   },
   "resolutions": {
     "chokidar": "^4.0.0"
   },
-  "gitHead": "90d1ca9626408c05df664a25bcdca7cb1a0377de"
+  "gitHead": "604b6123a4e495717e4fdde55d1ad1c52cb81724"
 }

package/src/cli.js

@@ -188,7 +188,7 @@ const run = async () => {
   const t = args.indexOf("--target") !== -1 ? args.indexOf("--target") : args.indexOf("-t");
   const tExt = args.indexOf("--targetExt") !== -1 ? args.indexOf("--targetExt") : args.indexOf("-tx");
   const init = args.indexOf("init") >= 0;
-  const targetName = t !== -1 ? `@citolab/tspci-${args[t]}` : tExt !== -1 ? args[tExt] : null;
+  const targetName = t !== -1 ? `@citolab/tspci-${args[t + 1]}` : tExt !== -1 ? args[tExt + 1] : null;
 
   if (help) {
     console.log(`•\t${chalk.blueBright("--help -h")} list these commands`);

package/types/index.d.ts

@@ -1,4 +1,31 @@
-export interface IMSpci<ConfigProperties> {
+// Define the payload structure for the custom event
+export interface QtiInteractionChangedDetail {
+  interaction: IMSpci<ConfigProperties>; // 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()
+}
+
+// Define the ConfigProperties interface
+export interface ConfigProperties {
+  properties: Record<string, string>; // Follows dataset conversion rules (camelCased keys)
+  templateVariables: Record<string, QtiVariableJSON>; // Follows structure in Appendix C
+  contextVariables: Record<string, QtiVariableJSON>; // Follows structure in Appendix C
+  boundTo: Record<string, QtiVariableJSON>; // Follows structure in Appendix C
+  responseIdentifier: string; // Unique within interaction scope
+
+  onready: (interaction: IMSpci<ConfigProperties>, state?: string) => void; // Callback when PCI is fully constructed and ready
+  ondone?: (
+    interaction: IMSpci<ConfigProperties>,
+    response: Record<string, QtiVariableJSON>,
+    state: string,
+    status?: "interacting" | "closed" | "solution" | "review"
+  ) => void; // Optional callback when candidate finishes interaction
+
+  status?: "interacting" | "suspended" | "closed" | "solution" | "review"; // Optional, defaults to "interacting"
+}
+
+export interface IMSpci<CustomConfigProperties extends ConfigProperties> {
   typeIdentifier: string;
 
   /** @access public
@@ -10,13 +37,13 @@ export interface IMSpci<ConfigProperties> {
    *  This must have been obtained from a prior call to getState on an
    *  instance of this type (same typeIdentifier)
    */
-  getInstance: (dom: HTMLElement, configuration: Configuration<ConfigProperties>, state: string) => void;
+  getInstance: (dom: HTMLElement, configuration: Configuration<CustomConfigProperties>, state: string) => void;
 
   /** @access public
    * @method getResponse
    * @return {Object} - the value to assign to the bound QTI response variable
    */
-  getResponse: () => QtiVariableJSON;
+  getResponse: () => QtiVariableJSON | undefined;
 
   /** @access public
    * @method getState
@@ -28,21 +55,9 @@ export interface IMSpci<ConfigProperties> {
   destroy?: () => void; // Not used in IMS and not in TAO implementation, so not used here (optional)
 }
 
-
-
-export declare type Configuration<T> = {
-  onready: (pci: IMSpci<T>, state?: string) => void;
+export declare type Configuration<T extends ConfigProperties> = {
+  onready: () => void;
   properties: T;
-  // PK: following this: https://www.imsglobal.org/spec/qti/v3p0/impl#h.1mc9puik2ft6
-  // All below are not used in the IMS Reference implementation, keeping for ref
-  /*    
-  ondone: (pci: IMSPci<T>,response:any,state:string, status?: "interacting" | "closed" | "solution" | "review" ) => void;
-  status: string;
-  templateVariables: any;  
-  boundTo: any;
-  contextVariables
-  responseIdentifier
-  */
 };
 
 export interface directedPair {