@resconet/qp-bridge 0.0.1-alpha.6 → 0.0.1-alpha.7

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

@@ -104,6 +104,32 @@ export declare const questionOptionalScheme: z.ZodObject<{
     required?: boolean | undefined;
     hidden?: boolean | undefined;
 }>;
+export declare const groupSchema: z.ZodObject<{
+    label: z.ZodString;
+    hidden: z.ZodBoolean;
+    collapsed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    hidden: boolean;
+    collapsed: boolean;
+}, {
+    label: string;
+    hidden: boolean;
+    collapsed: boolean;
+}>;
+export declare const groupOptionalScheme: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    collapsed: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    label?: string | undefined;
+    hidden?: boolean | undefined;
+    collapsed?: boolean | undefined;
+}, {
+    label?: string | undefined;
+    hidden?: boolean | undefined;
+    collapsed?: boolean | undefined;
+}>;
 export declare const getQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
@@ -229,6 +255,61 @@ export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
     };
     id?: string | undefined;
 }>;
+export declare const getGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"getGroup">;
+    group: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "getGroup";
+    group: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "getGroup";
+    group: string;
+    id?: string | undefined;
+}>;
+export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, {
+    group: z.ZodObject<{
+        label: z.ZodString;
+        hidden: z.ZodBoolean;
+        collapsed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        hidden: boolean;
+        collapsed: boolean;
+    }, {
+        label: string;
+        hidden: boolean;
+        collapsed: boolean;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    group: {
+        label: string;
+        hidden: boolean;
+        collapsed: boolean;
+    };
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    group: {
+        label: string;
+        hidden: boolean;
+        collapsed: boolean;
+    };
+    id?: string | undefined;
+}>;
 export declare const setAnswerRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
@@ -254,10 +335,14 @@ export type ResponseSuccessMessage = z.infer<typeof responseSuccessMessageSchema
 export type ResponseErrorMessage = z.infer<typeof responseErrorMessageSchema>;
 export type Question = z.infer<typeof questionSchema>;
 export type QuestionOptional = z.infer<typeof questionOptionalScheme>;
+export type Group = z.infer<typeof groupSchema>;
+export type GroupOptional = z.infer<typeof groupOptionalScheme>;
 export type OnAnswerChangeMessage = z.infer<typeof onAnswerChangeMessageSchema>;
 export type GetQuestionSuccessResponseMessage = z.infer<typeof getQuestionSuccessResponseMessageSchema>;
+export type GetGroupSuccessResponseMessage = z.infer<typeof getGroupSuccessResponseMessageSchema>;
 export type SetAnswerRequestMessage = z.infer<typeof setAnswerRequestMessageSchema>;
 export type GetQuestionRequestMessage = z.infer<typeof getQuestionRequestMessageSchema>;
+export type GetGroupRequestMessage = z.infer<typeof getGroupRequestMessageSchema>;
 export type SetQuestionRequestMessage = z.infer<typeof setQuestionRequestMessageSchema>;
 export declare function isOnAnswerChangeMessage(data: unknown): data is OnAnswerChangeMessage;
 export declare function isQpBridgeMessage(data: unknown): data is QpBridgeMessage;
@@ -267,3 +352,5 @@ export declare function isGetQuestionRequestMessage(data: unknown): data is GetQ
 export declare function isGetQuestionSuccessResponseMessage(data: unknown): data is GetQuestionSuccessResponseMessage;
 export declare function isSetAnswerRequestMessage(data: unknown): data is SetAnswerRequestMessage;
 export declare function isSetQuestionRequestMessage(data: unknown): data is SetQuestionRequestMessage;
+export declare function isGetGroupRequestMessage(data: unknown): data is GetGroupRequestMessage;
+export declare function isGetGroupSuccessResponseMessage(data: unknown): data is GetGroupSuccessResponseMessage;

package/lib/qp-bridge.d.ts

@@ -1,4 +1,4 @@
-import { Question, QuestionOptional } from './qp-bridge-types';
+import { Group, Question, QuestionOptional } from './qp-bridge-types';
 /**
  * Sets the answer for a specific question in the questionnaire.
  *
@@ -39,6 +39,21 @@ export declare function getQuestion(name: string): Promise<Question>;
  * ```
  */
 export declare function setQuestion(name: string, questionData: QuestionOptional): Promise<void>;
+/**
+ * Retrieves a group by its name from the questionnaire.
+ *
+ * @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.
+ * @example
+ * ```typescript
+ * const group = await getGroup('personalInfo');
+ * console.log(group.label); // Outputs the label of the group
+ * console.log(group.hidden); // Outputs whether the group is hidden
+ * console.log(group.collapsed); // Outputs whether the group is collapsed
+ * ```
+ */
+export declare function getGroup(name: string): Promise<Group>;
 /**
  * Subscribes to changes in answers for questions.
  * This function listens for messages from the parent window

package/package.json

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