@resconet/qp-bridge 1.4.0-alpha.5 → 1.4.0-alpha.6

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

@@ -231,6 +231,45 @@ export declare const groupOptionalScheme: z.ZodObject<{
     hidden?: boolean | undefined;
     collapsed?: boolean | undefined;
 }>;
+export declare const questionnaireSchema: z.ZodObject<{
+    isNew: z.ZodBoolean;
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    regarding: z.ZodOptional<z.ZodObject<{
+        entityName: z.ZodString;
+        id: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        entityName: string;
+    }, {
+        id: string;
+        name: string;
+        entityName: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+    isNew: boolean;
+    description?: string | undefined;
+    regarding?: {
+        id: string;
+        name: string;
+        entityName: string;
+    } | undefined;
+}, {
+    id: string;
+    label: string;
+    isNew: boolean;
+    description?: string | undefined;
+    regarding?: {
+        id: string;
+        name: string;
+        entityName: string;
+    } | undefined;
+}>;
 export declare const getQuestionRequestMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
@@ -458,6 +497,106 @@ export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<{
     id?: string | undefined;
     instanceId?: string | undefined;
 }>;
+export declare const getQuestionnaireRequestMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+    instanceId: z.ZodOptional<z.ZodString>;
+} & {
+    featureVersion: z.ZodOptional<z.ZodNumber>;
+} & {
+    action: z.ZodLiteral<"getQuestionnaire">;
+}, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "getQuestionnaire";
+    id?: string | undefined;
+    instanceId?: string | undefined;
+    featureVersion?: number | undefined;
+}, {
+    type: "qp-bridge";
+    action: "getQuestionnaire";
+    id?: string | undefined;
+    instanceId?: string | undefined;
+    featureVersion?: number | undefined;
+}>;
+export declare const getQuestionnaireSuccessResponseMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+    instanceId: z.ZodOptional<z.ZodString>;
+} & {
+    status: z.ZodLiteral<"success">;
+} & {
+    questionnaire: z.ZodObject<{
+        isNew: z.ZodBoolean;
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        regarding: z.ZodOptional<z.ZodObject<{
+            entityName: z.ZodString;
+            id: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            name: string;
+            entityName: string;
+        }, {
+            id: string;
+            name: string;
+            entityName: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+        isNew: boolean;
+        description?: string | undefined;
+        regarding?: {
+            id: string;
+            name: string;
+            entityName: string;
+        } | undefined;
+    }, {
+        id: string;
+        label: string;
+        isNew: boolean;
+        description?: string | undefined;
+        regarding?: {
+            id: string;
+            name: string;
+            entityName: string;
+        } | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    questionnaire: {
+        id: string;
+        label: string;
+        isNew: boolean;
+        description?: string | undefined;
+        regarding?: {
+            id: string;
+            name: string;
+            entityName: string;
+        } | undefined;
+    };
+    id?: string | undefined;
+    instanceId?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    questionnaire: {
+        id: string;
+        label: string;
+        isNew: boolean;
+        description?: string | undefined;
+        regarding?: {
+            id: string;
+            name: string;
+            entityName: string;
+        } | undefined;
+    };
+    id?: string | undefined;
+    instanceId?: string | undefined;
+}>;
 export declare const canSaveSuccessResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
@@ -884,6 +1023,7 @@ 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 Questionnaire = z.infer<typeof questionnaireSchema>;
 export type GroupOptional = z.infer<typeof groupOptionalScheme>;
 export type MediaItem = z.infer<typeof mediaItemSchema>;
 export type Entity = z.infer<typeof entitySchema>;
@@ -892,12 +1032,14 @@ 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 GetQuestionnaireSuccessResponseMessage = z.infer<typeof getQuestionnaireSuccessResponseMessageSchema>;
 export type CanSaveSuccessResponseMessage = z.infer<typeof canSaveSuccessResponseMessageSchema>;
 export type FetchEntitiesSuccessResponseMessage = z.infer<typeof fetchEntitiesSuccessResponseMessageSchema>;
 export type GetEntityByIdSuccessResponseMessage = z.infer<typeof getEntityByIdSuccessResponseMessageSchema>;
 export type SetAnswerRequestMessage = z.infer<typeof setAnswerRequestMessageSchema>;
 export type GetQuestionRequestMessage = z.infer<typeof getQuestionRequestMessageSchema>;
 export type GetGroupRequestMessage = z.infer<typeof getGroupRequestMessageSchema>;
+export type GetQuestionnaireRequestMessage = z.infer<typeof getQuestionnaireRequestMessageSchema>;
 export type SetQuestionRequestMessage = z.infer<typeof setQuestionRequestMessageSchema>;
 export type SetGroupRequestMessage = z.infer<typeof setGroupRequestMessageSchema>;
 export type BusyIndicatorStartRequestMessage = z.infer<typeof busyIndicatorStartRequestMessageSchema>;
@@ -927,7 +1069,9 @@ export declare function isSetAnswerRequestMessage(data: unknown): data is SetAns
 export declare function isSetQuestionRequestMessage(data: unknown): data is SetQuestionRequestMessage;
 export declare function isSetGroupRequestMessage(data: unknown): data is SetGroupRequestMessage;
 export declare function isGetGroupRequestMessage(data: unknown): data is GetGroupRequestMessage;
+export declare function isGetQuestionnaireRequestMessage(data: unknown): data is GetQuestionnaireRequestMessage;
 export declare function isGetGroupSuccessResponseMessage(data: unknown): data is GetGroupSuccessResponseMessage;
+export declare function isGetQuestionnaireSuccessResponseMessage(data: unknown): data is GetQuestionnaireSuccessResponseMessage;
 export declare function isCanSaveSuccessResponseMessage(data: unknown): data is CanSaveSuccessResponseMessage;
 export declare function isCanSaveRequestMessage(data: unknown): data is CanSaveRequestMessage;
 export declare function isBusyIndicatorStartRequestMessage(data: unknown): data is BusyIndicatorStartRequestMessage;

package/lib/qp-bridge.d.ts

@@ -1,4 +1,4 @@
-import { Entity, Group, GroupOptional, MediaItem, Question, QuestionOptional } from './qp-bridge-types';
+import { Entity, Group, GroupOptional, MediaItem, Question, QuestionOptional, Questionnaire } from './qp-bridge-types';
 export type QpBridgeOptions = {
     instanceId?: string;
 };
@@ -69,6 +69,27 @@ export declare function updateMediaItem(mediaItem: MediaItem, updates: Partial<{
 }>): MediaItem;
 export declare function initOnSaveMessageHandler(): void;
 export declare function removeOnSaveMessageHandler(): void;
+/**
+ * Retrieves a questionnaire on which the user is currently working.
+ *
+ * @returns {Promise<Questionnaire>} A promise that resolves to the questionnaire object.
+ *
+ * The resolved `Questionnaire` object has the following properties:
+ * - `isNew` — Whether the questionnaire is a new (unsaved) record.
+ * - `id` — Unique identifier (UUID) of the questionnaire record.
+ * - `label` — Display name of the questionnaire.
+ * - `description` _(optional)_ — Description or notes for the questionnaire.
+ * - `regarding` _(optional)_ — Reference to the related entity this questionnaire is associated with (`entityName`, `id`, `name`).
+ *
+ * @throws {Error} Throws if the questionnaire is not found or the operation fails.
+ * @example
+ * ```typescript
+ * const questionnaire = await getQuestionnaire();
+ * console.log(questionnaire.id); // Outputs the ID of the questionnaire
+ * console.log(questionnaire.isNew); // Outputs whether the questionnaire is new
+ * ```
+ */
+export declare function getQuestionnaire(options?: QpBridgeOptions): Promise<Questionnaire>;
 /**
  * Sets the answer for a specific question in the questionnaire.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@resconet/qp-bridge",
-	"version": "1.4.0-alpha.5",
+	"version": "1.4.0-alpha.6",
 	"main": "./index.js",
 	"module": "./index.mjs",
 	"typings": "./index.d.ts",