@resconet/qp-bridge 0.0.1-alpha.20 → 0.0.1-alpha.21

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

@@ -581,6 +581,63 @@ export declare const getEntityByIdSuccessResponseMessageSchema: z.ZodObject<z.ob
     entity: Record<string, unknown>;
     id?: string | undefined;
 }>;
+export declare const repeatGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"repeatGroup">;
+    parentGroupName: z.ZodString;
+    groupIndex: z.ZodNumber;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "repeatGroup";
+    parentGroupName: string;
+    groupIndex: number;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "repeatGroup";
+    parentGroupName: string;
+    groupIndex: number;
+    id?: string | undefined;
+}>;
+export declare const addNewGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"addNewGroup">;
+    groupName: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "addNewGroup";
+    groupName: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "addNewGroup";
+    groupName: string;
+    id?: string | undefined;
+}>;
+export declare const deleteGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"deleteGroup">;
+    parentGroupName: z.ZodString;
+    groupIndex: z.ZodNumber;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "deleteGroup";
+    parentGroupName: string;
+    groupIndex: number;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "deleteGroup";
+    parentGroupName: string;
+    groupIndex: number;
+    id?: string | undefined;
+}>;
 export type QpBridgeMessage = z.infer<typeof qpBridgeMessageSchema>;
 export type ResponseSuccessMessage = z.infer<typeof responseSuccessMessageSchema>;
 export type ResponseErrorMessage = z.infer<typeof responseErrorMessageSchema>;
@@ -609,6 +666,9 @@ export type ExecuteCustomCommandRequestMessage = z.infer<typeof executeCustomCom
 export type CanSaveRequestMessage = z.infer<typeof canSaveRequestMessageSchema>;
 export type FetchEntitiesRequestMessage = z.infer<typeof fetchEntitiesRequestMessageSchema>;
 export type GetEntityByIdRequestMessage = z.infer<typeof getEntityByIdRequestMessageSchema>;
+export type RepeatGroupRequestMessage = z.infer<typeof repeatGroupRequestMessageSchema>;
+export type AddNewGroupRequestMessage = z.infer<typeof addNewGroupRequestMessageSchema>;
+export type DeleteGroupRequestMessage = z.infer<typeof deleteGroupRequestMessageSchema>;
 export type WithBusyIndicatorRequestMessage = BusyIndicatorStartRequestMessage | BusyIndicatorEndRequestMessage;
 export declare function isMediaItem(data: unknown): data is MediaItem;
 export declare function isOnAnswerChangeMessage(data: unknown): data is OnAnswerChangeMessage;
@@ -634,3 +694,6 @@ export declare function isFetchEntitiesRequestMessage(data: unknown): data is Fe
 export declare function isFetchEntitiesSuccessResponseMessage(data: unknown): data is FetchEntitiesSuccessResponseMessage;
 export declare function isGetEntityByIdRequestMessage(data: unknown): data is GetEntityByIdRequestMessage;
 export declare function isGetEntityByIdSuccessResponseMessage(data: unknown): data is GetEntityByIdSuccessResponseMessage;
+export declare function isRepeatGroupRequestMessage(data: unknown): data is RepeatGroupRequestMessage;
+export declare function isAddNewGroupRequestMessage(data: unknown): data is AddNewGroupRequestMessage;
+export declare function isDeleteGroupRequestMessage(data: unknown): data is DeleteGroupRequestMessage;

package/lib/qp-bridge.d.ts

@@ -1,4 +1,4 @@
-import { Group, GroupOptional, MediaItem, Question, QuestionOptional, Entity } from './qp-bridge-types';
+import { Entity, Group, GroupOptional, MediaItem, Question, QuestionOptional } from './qp-bridge-types';
 /**
  * Creates a MediaItem from the provided parameters and content.
  *
@@ -265,4 +265,48 @@ export declare function fetchEntities(fetchXml: string): Promise<Entity[]>;
  * ```
  */
 export declare function getEntityById(entityName: string, id: string): Promise<Entity>;
+/**
+ * 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 {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.
+ * @example
+ * ```typescript
+ * await repeatGroup('personalInfoRepeatable', 1);
+ * console.log('Group repeated successfully');
+ * ```
+ */
+export declare function repeatGroup(parentGroupName: 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.
+ * @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
+ * ```typescript
+ * await addNewGroup('personalInfoRepeatable');
+ * console.log('New group added successfully');
+ * ```
+ */
+export declare function addNewGroup(name: 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 {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.
+ * @example
+ * ```typescript
+ * await deleteGroup('personalInfoRepeatable', 1);
+ * console.log('Group deleted successfully');
+ * ```
+ */
+export declare function deleteGroup(parentGroupName: string, groupIndex: number): Promise<void>;
 export {};

package/package.json

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