@resconet/qp-bridge 0.0.1-alpha.24 → 0.0.1-alpha.25

package/README.md

@@ -7,7 +7,7 @@ A JavaScript bridge library for communication between iframes in Questionnaire a
 
 ## Description
 
-qp-bridge provides a simple and reliable way to communicate between components in questionnaire environments. It handles messaging, serialization, and error handling for seamless interaction.
+qp-bridge provides a simple and reliable way to communicate between questionnaire and users logic.
 
 ## Installation
 
@@ -246,7 +246,7 @@ MediaItem object with blobUrl generated from the content.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -270,7 +270,7 @@ Updated MediaItem object.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -294,7 +294,7 @@ Updated MediaItem object.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -318,7 +318,7 @@ Updated MediaItem object.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -342,7 +342,7 @@ Updated MediaItem object.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -366,7 +366,7 @@ Updated MediaItem object.
 
 ### updateMediaItem
 
-Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+Updates a MediaItem with the provided changes.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -419,7 +419,7 @@ Retrieves a question by its name from the questionnaire.
 
 | Function | Type |
 | ---------- | ---------- |
-| `getQuestion` | `(name: string) => Promise<{ label: string; description: string; disabled: boolean; required: boolean; hidden: boolean; semanticColor?: string or undefined; errorMessage?: string or undefined; }>` |
+| `getQuestion` | `(name: string) => Promise<{ label: string; description: string; disabled: boolean; required: boolean; hidden: boolean; semanticColor?: string or undefined; errorMessage?: string or undefined; answer?: unknown; }>` |
 
 Parameters:
 
@@ -444,7 +444,7 @@ Updates a question in the questionnaire.
 
 | Function | Type |
 | ---------- | ---------- |
-| `setQuestion` | `(name: string, questionData: { semanticColor?: string or undefined; label?: string or undefined; description?: string or undefined; disabled?: boolean or undefined; required?: boolean or undefined; hidden?: boolean or undefined; errorMessage?: string or undefined; }) => Promise<...>` |
+| `setQuestion` | `(name: string, questionData: { semanticColor?: string or undefined; label?: string or undefined; description?: string or undefined; disabled?: boolean or undefined; required?: boolean or undefined; hidden?: boolean or undefined; errorMessage?: string or undefined; answer?: unknown; }) => Promise<...>` |
 
 Parameters:
 
@@ -736,11 +736,11 @@ The parent group must be a repeatable group and the index must refer to an exist
 
 | Function | Type |
 | ---------- | ---------- |
-| `repeatGroup` | `(parentGroupName: string, groupIndex: number) => Promise<void>` |
+| `repeatGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
 
 Parameters:
 
-* `parentGroupName`: - The name of the parent repeatable group.
+* `repeatableGroupName`: - The name of the parent repeatable group.
 * `groupIndex`: - The index (0-based) of the group instance to repeat.
 
 
@@ -763,11 +763,11 @@ The specified name must refer to a repeatable group.
 
 | Function | Type |
 | ---------- | ---------- |
-| `addNewGroup` | `(name: string) => Promise<void>` |
+| `addNewGroup` | `(repeatableGroupName: string) => Promise<void>` |
 
 Parameters:
 
-* `name`: - The name of the repeatable group to add a new instance to.
+* `repeatableGroupName`: - The name of the repeatable group to add a new instance to.
 
 
 Returns:
@@ -789,11 +789,11 @@ The parent group must be a repeatable group and the index must refer to an exist
 
 | Function | Type |
 | ---------- | ---------- |
-| `deleteGroup` | `(parentGroupName: string, groupIndex: number) => Promise<void>` |
+| `deleteGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
 
 Parameters:
 
-* `parentGroupName`: - The name of the parent repeatable group.
+* `repeatableGroupName`: - The name of the parent repeatable group.
 * `groupIndex`: - The index (0-based) of the group instance to delete.
 
 

package/lib/qp-bridge.d.ts

@@ -29,7 +29,7 @@ export declare function createMediaItem(name: string, mimeType: string, content:
 export declare function createMediaItem(name: string, mimeType: string, content: ArrayBuffer): MediaItem;
 export declare function createMediaItem(name: string, mimeType: string, content: File | Blob | string | ArrayBuffer, id?: string): MediaItem;
 /**
- * Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+ * Updates a MediaItem with the provided changes.
  *
  * @param mediaItem - The original MediaItem to update.
  * @param updates - Object containing properties to update (name, mimeType, content).
@@ -269,7 +269,7 @@ export declare function getEntityById(entityName: string, id: string): Promise<E
  * Repeats a specific group within a repeatable group by creating a copy of the group at the specified index.
  * The parent group must be a repeatable group and the index must refer to an existing group instance.
  *
- * @param {string} parentGroupName - The name of the parent repeatable group.
+ * @param {string} repeatableGroupName - The name of the parent repeatable group.
  * @param {number} groupIndex - The index (0-based) of the group instance to repeat.
  * @returns {Promise<void>} A promise that resolves when the group has been successfully repeated.
  * @throws {Error} Throws if the parent group is not found, is not a repeatable group, the index is invalid, or the operation fails.
@@ -279,12 +279,12 @@ export declare function getEntityById(entityName: string, id: string): Promise<E
  * console.log('Group repeated successfully');
  * ```
  */
-export declare function repeatGroup(parentGroupName: string, groupIndex: number): Promise<void>;
+export declare function repeatGroup(repeatableGroupName: string, groupIndex: number): Promise<void>;
 /**
  * Adds a new group instance to a repeatable group.
  * The specified name must refer to a repeatable group.
  *
- * @param {string} name - The name of the repeatable group to add a new instance to.
+ * @param {string} repeatableGroupName - The name of the repeatable group to add a new instance to.
  * @returns {Promise<void>} A promise that resolves when the new group has been successfully added.
  * @throws {Error} Throws if the repeatable group is not found or the operation fails.
  * @example
@@ -293,12 +293,12 @@ export declare function repeatGroup(parentGroupName: string, groupIndex: number)
  * console.log('New group added successfully');
  * ```
  */
-export declare function addNewGroup(name: string): Promise<void>;
+export declare function addNewGroup(repeatableGroupName: string): Promise<void>;
 /**
  * Deletes a specific group instance from a repeatable group by index.
  * The parent group must be a repeatable group and the index must refer to an existing group instance.
  *
- * @param {string} parentGroupName - The name of the parent repeatable group.
+ * @param {string} repeatableGroupName - The name of the parent repeatable group.
  * @param {number} groupIndex - The index (0-based) of the group instance to delete.
  * @returns {Promise<void>} A promise that resolves when the group has been successfully deleted.
  * @throws {Error} Throws if the parent group is not found, is not a repeatable group, the index is invalid, or the operation fails.
@@ -308,5 +308,5 @@ export declare function addNewGroup(name: string): Promise<void>;
  * console.log('Group deleted successfully');
  * ```
  */
-export declare function deleteGroup(parentGroupName: string, groupIndex: number): Promise<void>;
+export declare function deleteGroup(repeatableGroupName: string, groupIndex: number): Promise<void>;
 export {};

package/package.json

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