@resconet/qp-bridge 0.0.1-alpha.12 → 0.0.1-alpha.13

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

@@ -398,6 +398,20 @@ export declare const busyIndicatorEndRequestMessageSchema: z.ZodObject<z.objectU
     action: "busyIndicatorEnd";
     id?: string | undefined;
 }>;
+export declare const saveQuestionnaireRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"saveQuestionnaire">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "saveQuestionnaire";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "saveQuestionnaire";
+    id?: string | undefined;
+}>;
 export type QpBridgeMessage = z.infer<typeof qpBridgeMessageSchema>;
 export type ResponseSuccessMessage = z.infer<typeof responseSuccessMessageSchema>;
 export type ResponseErrorMessage = z.infer<typeof responseErrorMessageSchema>;
@@ -415,6 +429,7 @@ export type SetQuestionRequestMessage = z.infer<typeof setQuestionRequestMessage
 export type SetGroupRequestMessage = z.infer<typeof setGroupRequestMessageSchema>;
 export type BusyIndicatorStartRequestMessage = z.infer<typeof busyIndicatorStartRequestMessageSchema>;
 export type BusyIndicatorEndRequestMessage = z.infer<typeof busyIndicatorEndRequestMessageSchema>;
+export type SaveQuestionnaireRequestMessage = z.infer<typeof saveQuestionnaireRequestMessageSchema>;
 export type WithBusyIndicatorRequestMessage = BusyIndicatorStartRequestMessage | BusyIndicatorEndRequestMessage;
 export declare function isOnAnswerChangeMessage(data: unknown): data is OnAnswerChangeMessage;
 export declare function isQpBridgeMessage(data: unknown): data is QpBridgeMessage;
@@ -429,4 +444,5 @@ export declare function isGetGroupRequestMessage(data: unknown): data is GetGrou
 export declare function isGetGroupSuccessResponseMessage(data: unknown): data is GetGroupSuccessResponseMessage;
 export declare function isBusyIndicatorStartRequestMessage(data: unknown): data is BusyIndicatorStartRequestMessage;
 export declare function isBusyIndicatorEndRequestMessage(data: unknown): data is BusyIndicatorEndRequestMessage;
+export declare function isSaveQuestionnaireRequestMessage(data: unknown): data is SaveQuestionnaireRequestMessage;
 export declare function isWithBusyIndicatorRequestMessage(data: unknown): data is WithBusyIndicatorRequestMessage;

package/lib/qp-bridge.d.ts

@@ -5,7 +5,7 @@ import { Group, GroupOptional, Question, QuestionOptional } from './qp-bridge-ty
  * @param {string} questionName - Name of the question for which the answer is being set.
  * @param {*} answer - The answer to set for the question. Can be any type.
  * @returns {Promise<void>} A promise that resolves when the answer has been successfully set.
- * @throws {Error} Throws if the message from the parent window indicates a failure.
+ * @throws {Error} Throws if the operation fails.
  * @example
  * ```typescript
  * await setAnswer('favoriteColor', 'blue');
@@ -18,7 +18,7 @@ export declare function setAnswer(questionName: string, answer: unknown): Promis
  *
  * @param {string} name - The name of the question to retrieve.
  * @returns {Promise<Question>} A promise that resolves to the question object.
- * @throws {Error} Throws if the message from the parent window indicates a failure.
+ * @throws {Error} Throws if the question is not found or the operation fails.
  * @example
  * ```typescript
  * const question = await getQuestion('favoriteColor');
@@ -32,7 +32,7 @@ export declare function getQuestion(name: string): Promise<Question>;
  * @param {string} name - The name of the question to update. This is a unique identifier and cannot be changed.
  * @param {QuestionOptional} questionData - The updated question data excluding the name property.
  * @returns {Promise<void>} A promise that resolves when the question has been successfully updated.
- * @throws {Error} Throws if the message from the parent window indicates a failure.
+ * @throws {Error} Throws if the question is not found or the operation fails.
  * @example
  * ```typescript
  * await setQuestion('favoriteColor', { label: 'What is your favorite color?' });
@@ -44,7 +44,7 @@ export declare function setQuestion(name: string, questionData: QuestionOptional
  *
  * @param {string} name - The name of the group to retrieve.
  * @returns {Promise<Group>} A promise that resolves to the group object.
- * @throws {Error} Throws if the message from the parent window indicates a failure.
+ * @throws {Error} Throws if the group is not found or the operation fails.
  * @example
  * ```typescript
  * const group = await getGroup('personalInfo');
@@ -60,7 +60,7 @@ export declare function getGroup(name: string): Promise<Group>;
  * @param {string} name - The name of the group to update. This is a unique identifier and cannot be changed.
  * @param {GroupOptional} groupData - The updated group data excluding the name property.
  * @returns {Promise<void>} A promise that resolves when the group has been successfully updated.
- * @throws {Error} Throws if the message from the parent window indicates a failure.
+ * @throws {Error} Throws if the group is not found or the operation fails.
  * @example
  * ```typescript
  * await setGroup('personalInfo', { label: 'Personal Information', hidden: false, collapsed: true });
@@ -69,14 +69,13 @@ export declare function getGroup(name: string): Promise<Group>;
 export declare function setGroup(name: string, groupData: GroupOptional): Promise<void>;
 /**
  * Subscribes to changes in answers for questions.
- * This function listens for messages from the parent window
- * and invokes the provided listener whenever an answer changes.
+ * Calls the provided listener whenever an answer changes in the questionnaire.
  * @param listener - A function that will be called with the question name and the new answer whenever an answer changes.
  * @return An object with a `cancelSubscription` method to stop listening for changes.
  * @example
  * ```typescript
  * import { onAnswerChange } from 'qp-bridge';
- * const { cancelSubsctiprion } = onAnswerChange((question, answer) => {
+ * const { cancelSubscription } = onAnswerChange((question, answer) => {
  *  console.log(`Answer for ${question} changed to:`, answer);
  *  });
  *
@@ -89,9 +88,8 @@ export declare function onAnswerChange(listener: (question: string, answer: unkn
 };
 /**
  * Wraps an asynchronous action with a busy indicator in the host application.
- * Sends a `busyIndicatorStart` message before executing the provided action and
- * a `busyIndicatorEnd` message afterwards. The end message is sent even if the
- * action rejects (finally semantics), ensuring the UI is not left in a busy state.
+ * Shows a loading indicator during the execution of the provided action,
+ * ensuring the UI reflects the busy state appropriately.
  *
  * @typeParam T - The resolved type of the provided async action.
  * @param action - A function returning a promise whose execution should be wrapped.
@@ -107,3 +105,16 @@ export declare function onAnswerChange(listener: (question: string, answer: unkn
  * ```
  */
 export declare function withBusyIndicator<T>(action: () => Promise<T>): Promise<T>;
+/**
+ * Saves the current questionnaire state.
+ * Triggers a save operation for the questionnaire data.
+ *
+ * @returns {Promise<void>} A promise that resolves when the questionnaire has been successfully saved.
+ * @throws {Error} Throws if the save operation fails.
+ * @example
+ * ```typescript
+ * await saveQuestionnaire();
+ * console.log('Questionnaire saved successfully');
+ * ```
+ */
+export declare function saveQuestionnaire(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@resconet/qp-bridge",
-	"version": "0.0.1-alpha.12",
+	"version": "0.0.1-alpha.13",
 	"dependencies": {
 		"zod": "^3.23.8",
 		"uuid": "^9.0.1"