@resconet/qp-bridge 1.1.0 → 1.1.1-alpha.31

package/lib/qp-bridge-types.d.ts

@@ -9,14 +9,14 @@ export declare const qpBridgeMessageSchema: z.ZodObject<{
     type: "qp-bridge";
     id?: string | undefined;
 }>;
-export declare const onAnswerChangeMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const onAnswerChangeMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"answerChanged">;
     question: z.ZodString;
     answer: z.ZodUnknown;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "answerChanged";
     question: string;
@@ -29,12 +29,43 @@ export declare const onAnswerChangeMessageSchema: z.ZodObject<z.objectUtil.exten
     id?: string | undefined;
     answer?: unknown;
 }>;
-export declare const responseSuccessMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const commandExecutedMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+} & {
+    action: z.ZodLiteral<"commandExecuted">;
+    commandName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "commandExecuted";
+    commandName: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "commandExecuted";
+    commandName: string;
+    id?: string | undefined;
+}>;
+export declare const questionnaireLoadedMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
+} & {
+    action: z.ZodLiteral<"questionnaireLoaded">;
+}, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "questionnaireLoaded";
+    id?: string | undefined;
 }, {
+    type: "qp-bridge";
+    action: "questionnaireLoaded";
+    id?: string | undefined;
+}>;
+export declare const responseSuccessMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+} & {
     status: z.ZodLiteral<"success">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     id?: string | undefined;
@@ -43,13 +74,13 @@ export declare const responseSuccessMessageSchema: z.ZodObject<z.objectUtil.exte
     status: "success";
     id?: string | undefined;
 }>;
-export declare const responseErrorMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const responseErrorMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"error">;
     message: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "error";
     message: string;
@@ -159,13 +190,13 @@ export declare const groupOptionalScheme: z.ZodObject<{
     hidden?: boolean | undefined;
     collapsed?: boolean | undefined;
 }>;
-export declare const getQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const getQuestionRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"getQuestion">;
     question: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     question: string;
     action: "getQuestion";
@@ -176,12 +207,12 @@ export declare const getQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
     action: "getQuestion";
     id?: string | undefined;
 }>;
-export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"success">;
-}>, {
+} & {
     question: z.ZodObject<{
         semanticColor: z.ZodOptional<z.ZodString>;
         label: z.ZodString;
@@ -210,7 +241,7 @@ export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.obje
         semanticColor?: string | undefined;
         errorMessage?: string | undefined;
     }>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     question: {
@@ -239,10 +270,10 @@ export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.obje
     };
     id?: string | undefined;
 }>;
-export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const setQuestionRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"setQuestion">;
     question: z.ZodString;
     questionData: z.ZodObject<{
@@ -273,7 +304,7 @@ export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
         hidden?: boolean | undefined;
         errorMessage?: string | undefined;
     }>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     question: string;
     action: "setQuestion";
@@ -304,13 +335,13 @@ export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
     };
     id?: string | undefined;
 }>;
-export declare const getGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const getGroupRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"getGroup">;
     group: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "getGroup";
     group: string;
@@ -321,12 +352,12 @@ export declare const getGroupRequestMessageSchema: z.ZodObject<z.objectUtil.exte
     group: string;
     id?: string | undefined;
 }>;
-export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"success">;
-}>, {
+} & {
     group: z.ZodObject<{
         label: z.ZodString;
         hidden: z.ZodBoolean;
@@ -340,7 +371,7 @@ export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<z.objectU
         hidden: boolean;
         collapsed: boolean;
     }>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     group: {
@@ -359,14 +390,14 @@ export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<z.objectU
     };
     id?: string | undefined;
 }>;
-export declare const canSaveSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const canSaveSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"success">;
-}>, {
+} & {
     canSave: z.ZodBoolean;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     canSave: boolean;
@@ -377,12 +408,12 @@ export declare const canSaveSuccessResponseMessageSchema: z.ZodObject<z.objectUt
     canSave: boolean;
     id?: string | undefined;
 }>;
-export declare const canSaveRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const canSaveRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"canSave">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "canSave";
     id?: string | undefined;
@@ -391,10 +422,10 @@ export declare const canSaveRequestMessageSchema: z.ZodObject<z.objectUtil.exten
     action: "canSave";
     id?: string | undefined;
 }>;
-export declare const setGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const setGroupRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"setGroup">;
     group: z.ZodString;
     groupData: z.ZodObject<{
@@ -410,7 +441,7 @@ export declare const setGroupRequestMessageSchema: z.ZodObject<z.objectUtil.exte
         hidden?: boolean | undefined;
         collapsed?: boolean | undefined;
     }>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "setGroup";
     group: string;
@@ -431,14 +462,14 @@ export declare const setGroupRequestMessageSchema: z.ZodObject<z.objectUtil.exte
     };
     id?: string | undefined;
 }>;
-export declare const setAnswerRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const setAnswerRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"setAnswer">;
     question: z.ZodString;
     answer: z.ZodUnknown;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     question: string;
     action: "setAnswer";
@@ -451,12 +482,12 @@ export declare const setAnswerRequestMessageSchema: z.ZodObject<z.objectUtil.ext
     id?: string | undefined;
     answer?: unknown;
 }>;
-export declare const busyIndicatorStartRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const busyIndicatorStartRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"busyIndicatorStart">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "busyIndicatorStart";
     id?: string | undefined;
@@ -465,12 +496,12 @@ export declare const busyIndicatorStartRequestMessageSchema: z.ZodObject<z.objec
     action: "busyIndicatorStart";
     id?: string | undefined;
 }>;
-export declare const busyIndicatorEndRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const busyIndicatorEndRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"busyIndicatorEnd">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "busyIndicatorEnd";
     id?: string | undefined;
@@ -479,12 +510,12 @@ export declare const busyIndicatorEndRequestMessageSchema: z.ZodObject<z.objectU
     action: "busyIndicatorEnd";
     id?: string | undefined;
 }>;
-export declare const saveQuestionnaireRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const saveQuestionnaireRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"saveQuestionnaire">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "saveQuestionnaire";
     id?: string | undefined;
@@ -493,12 +524,12 @@ export declare const saveQuestionnaireRequestMessageSchema: z.ZodObject<z.object
     action: "saveQuestionnaire";
     id?: string | undefined;
 }>;
-export declare const completeAndCloseQuestionnaireRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const completeAndCloseQuestionnaireRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"completeAndCloseQuestionnaire">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "completeAndCloseQuestionnaire";
     id?: string | undefined;
@@ -507,13 +538,13 @@ export declare const completeAndCloseQuestionnaireRequestMessageSchema: z.ZodObj
     action: "completeAndCloseQuestionnaire";
     id?: string | undefined;
 }>;
-export declare const executeCustomCommandRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const executeCustomCommandRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"executeCustomCommand">;
     commandName: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "executeCustomCommand";
     commandName: string;
@@ -524,13 +555,13 @@ export declare const executeCustomCommandRequestMessageSchema: z.ZodObject<z.obj
     commandName: string;
     id?: string | undefined;
 }>;
-export declare const fetchEntitiesRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const fetchEntitiesRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"fetchEntities">;
     fetchXml: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "fetchEntities";
     fetchXml: string;
@@ -541,14 +572,14 @@ export declare const fetchEntitiesRequestMessageSchema: z.ZodObject<z.objectUtil
     fetchXml: string;
     id?: string | undefined;
 }>;
-export declare const fetchEntitiesSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const fetchEntitiesSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"success">;
-}>, {
+} & {
     entities: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     entities: Record<string, unknown>[];
@@ -559,14 +590,14 @@ export declare const fetchEntitiesSuccessResponseMessageSchema: z.ZodObject<z.ob
     entities: Record<string, unknown>[];
     id?: string | undefined;
 }>;
-export declare const getEntityByIdRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const getEntityByIdRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"getEntityById">;
     entityName: z.ZodString;
     entityId: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "getEntityById";
     entityName: string;
@@ -579,14 +610,14 @@ export declare const getEntityByIdRequestMessageSchema: z.ZodObject<z.objectUtil
     entityId: string;
     id?: string | undefined;
 }>;
-export declare const getEntityByIdSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const getEntityByIdSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     status: z.ZodLiteral<"success">;
-}>, {
+} & {
     entity: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     status: "success";
     entity: Record<string, unknown>;
@@ -597,13 +628,13 @@ export declare const getEntityByIdSuccessResponseMessageSchema: z.ZodObject<z.ob
     entity: Record<string, unknown>;
     id?: string | undefined;
 }>;
-export declare const saveEntityRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const saveEntityRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"saveEntity">;
     entity: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "saveEntity";
     entity: Record<string, unknown>;
@@ -614,14 +645,14 @@ export declare const saveEntityRequestMessageSchema: z.ZodObject<z.objectUtil.ex
     entity: Record<string, unknown>;
     id?: string | undefined;
 }>;
-export declare const repeatGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const repeatGroupRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"repeatGroup">;
     parentGroupName: z.ZodString;
     groupIndex: z.ZodNumber;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "repeatGroup";
     parentGroupName: string;
@@ -634,13 +665,13 @@ export declare const repeatGroupRequestMessageSchema: z.ZodObject<z.objectUtil.e
     groupIndex: number;
     id?: string | undefined;
 }>;
-export declare const addNewGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const addNewGroupRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"addNewGroup">;
     groupName: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "addNewGroup";
     groupName: string;
@@ -651,14 +682,14 @@ export declare const addNewGroupRequestMessageSchema: z.ZodObject<z.objectUtil.e
     groupName: string;
     id?: string | undefined;
 }>;
-export declare const deleteGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+export declare const deleteGroupRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
-}, {
+} & {
     action: z.ZodLiteral<"deleteGroup">;
     parentGroupName: z.ZodString;
     groupIndex: z.ZodNumber;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     action: "deleteGroup";
     parentGroupName: string;
@@ -681,6 +712,8 @@ export type GroupOptional = z.infer<typeof groupOptionalScheme>;
 export type MediaItem = z.infer<typeof mediaItemSchema>;
 export type Entity = z.infer<typeof entitySchema>;
 export type OnAnswerChangeMessage = z.infer<typeof onAnswerChangeMessageSchema>;
+export type CommandExecutedMessage = z.infer<typeof commandExecutedMessageSchema>;
+export type QuestionnaireLoadedMessage = z.infer<typeof questionnaireLoadedMessageSchema>;
 export type GetQuestionSuccessResponseMessage = z.infer<typeof getQuestionSuccessResponseMessageSchema>;
 export type GetGroupSuccessResponseMessage = z.infer<typeof getGroupSuccessResponseMessageSchema>;
 export type CanSaveSuccessResponseMessage = z.infer<typeof canSaveSuccessResponseMessageSchema>;
@@ -706,6 +739,8 @@ export type DeleteGroupRequestMessage = z.infer<typeof deleteGroupRequestMessage
 export type WithBusyIndicatorRequestMessage = BusyIndicatorStartRequestMessage | BusyIndicatorEndRequestMessage;
 export declare function isMediaItem(data: unknown): data is MediaItem;
 export declare function isOnAnswerChangeMessage(data: unknown): data is OnAnswerChangeMessage;
+export declare function isCommandExecutedMessage(data: unknown): data is CommandExecutedMessage;
+export declare function isQuestionnaireLoadedMessage(data: unknown): data is QuestionnaireLoadedMessage;
 export declare function isQpBridgeMessage(data: unknown): data is QpBridgeMessage;
 export declare function isSuccessMessage(data: unknown): data is ResponseSuccessMessage;
 export declare function isErrorMessage(data: unknown): data is ResponseErrorMessage;

package/lib/qp-bridge.d.ts

@@ -211,6 +211,46 @@ export declare function completeAndCloseQuestionnaire(): Promise<void>;
  */
 export declare function executeCustomCommand(commandName: string): Promise<void>;
 type Validator = () => Promise<boolean>;
+/**
+ * Registers a handler function to be called when the questionnaire is fully loaded.
+ * Useful for performing actions that depend on the questionnaire being ready.
+ *
+ * @param handler - A function to be called when the questionnaire is loaded.
+ * @returns An object with a `cancelSubscription` method to unregister the handler.
+ * @example
+ * ```typescript
+ * import { onQuestionnaireLoaded } from 'qp-bridge';
+ * const { cancelSubscription } = onQuestionnaireLoaded(() => {
+ *   console.log('Questionnaire is fully loaded');
+ * });
+ *
+ * // To stop listening for questionnaire load events:
+ * cancelSubscription();
+ * ```
+ */
+export declare function onQuestionnaireLoaded(handler: () => void): {
+    cancelSubscription: () => void;
+};
+/**
+ * Registers a handler function to be called when a command is executed.
+ * Useful for reacting to custom command executions within the questionnaire.
+ *
+ * @param handler - A function that receives the name of the executed command.
+ * @returns An object with a `cancelSubscription` method to unregister the handler.
+ * @example
+ * ```typescript
+ * import { onCommandExecuted } from 'qp-bridge';
+ * const { cancelSubscription } = onCommandExecuted((commandName) => {
+ *   console.log(`Command executed: ${commandName}`);
+ * });
+ *
+ * // To stop listening for command executions:
+ * cancelSubscription();
+ * ```
+ */
+export declare function onCommandExecuted(handler: (commandName: string) => void): {
+    cancelSubscription: () => void;
+};
 /**
  * Registers a validator function to be called when a save event occurs.
  * Useful for validating data before saving the questionnaire.

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@resconet/qp-bridge",
-	"version": "1.1.0",
-	"dependencies": {
-		"zod": "^3.23.8",
-		"uuid": "^9.0.1"
-	},
+	"version": "1.1.1-alpha.31",
 	"main": "./index.js",
 	"module": "./index.mjs",
-	"typings": "./index.d.ts"
+	"typings": "./index.d.ts",
+	"dependencies": {
+		"uuid": "^9.0.1",
+		"zod": "^3.23.8"
+	}
 }