@resconet/qp-bridge 1.1.1-alpha.34 → 1.2.0-alpha.35

package/README.md

@@ -53,6 +53,8 @@ await setAnswer("numericQuestion", 42);
 - [updateMediaItem](#updatemediaitem)
 - [updateMediaItem](#updatemediaitem)
 - [updateMediaItem](#updatemediaitem)
+- [initOnSaveMessageHandler](#initonsavemessagehandler)
+- [removeOnSaveMessageHandler](#removeonsavemessagehandler)
 - [setAnswer](#setanswer)
 - [getQuestion](#getquestion)
 - [setQuestion](#setquestion)
@@ -63,6 +65,8 @@ await setAnswer("numericQuestion", 42);
 - [saveQuestionnaire](#savequestionnaire)
 - [completeAndCloseQuestionnaire](#completeandclosequestionnaire)
 - [executeCustomCommand](#executecustomcommand)
+- [onQuestionnaireLoaded](#onquestionnaireloaded)
+- [onCommandExecuted](#oncommandexecuted)
 - [onSave](#onsave)
 - [fetchEntities](#fetchentities)
 - [getEntityById](#getentitybyid)
@@ -390,6 +394,18 @@ Returns:
 
 Updated MediaItem object.
 
+### initOnSaveMessageHandler
+
+| Function | Type |
+| ---------- | ---------- |
+| `initOnSaveMessageHandler` | `() => void` |
+
+### removeOnSaveMessageHandler
+
+| Function | Type |
+| ---------- | ---------- |
+| `removeOnSaveMessageHandler` | `() => void` |
+
 ### setAnswer
 
 Sets the answer for a specific question in the questionnaire.
@@ -642,6 +658,68 @@ console.log('Custom command executed successfully');
 ```
 
 
+### onQuestionnaireLoaded
+
+Registers a handler function to be called when the questionnaire is fully loaded.
+Useful for performing actions that depend on the questionnaire being ready.
+
+| Function | Type |
+| ---------- | ---------- |
+| `onQuestionnaireLoaded` | `(handler: () => void) => { cancelSubscription: () => void; }` |
+
+Parameters:
+
+* `handler`: - A function to be called when the questionnaire is loaded.
+
+
+Returns:
+
+An object with a `cancelSubscription` method to unregister the handler.
+
+Examples:
+
+```typescript
+import { onQuestionnaireLoaded } from 'qp-bridge';
+const { cancelSubscription } = onQuestionnaireLoaded(() => {
+  console.log('Questionnaire is fully loaded');
+});
+
+// To stop listening for questionnaire load events:
+cancelSubscription();
+```
+
+
+### onCommandExecuted
+
+Registers a handler function to be called when a command is executed.
+Useful for reacting to custom command executions within the questionnaire.
+
+| Function | Type |
+| ---------- | ---------- |
+| `onCommandExecuted` | `(handler: (commandName: string) => void) => { cancelSubscription: () => void; }` |
+
+Parameters:
+
+* `handler`: - A function that receives the name of the executed command.
+
+
+Returns:
+
+An object with a `cancelSubscription` method to unregister the handler.
+
+Examples:
+
+```typescript
+import { onCommandExecuted } from 'qp-bridge';
+const { cancelSubscription } = onCommandExecuted((commandName) => {
+  console.log(`Command executed: ${commandName}`);
+});
+
+// To stop listening for command executions:
+cancelSubscription();
+```
+
+
 ### onSave
 
 Registers a validator function to be called when a save event occurs.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@resconet/qp-bridge",
-	"version": "1.1.1-alpha.34",
+	"version": "1.2.0-alpha.35",
 	"main": "./index.js",
 	"module": "./index.mjs",
 	"typings": "./index.d.ts",