@resconet/qp-bridge 0.0.1-alpha.10

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

@@ -0,0 +1,356 @@
+import { z } from 'zod';
+export declare const qpBridgeMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    id?: string | undefined;
+}>;
+export declare const onAnswerChangeMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"answerChanged">;
+    question: z.ZodString;
+    answer: z.ZodUnknown;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "answerChanged";
+    question: string;
+    id?: string | undefined;
+    answer?: unknown;
+}, {
+    type: "qp-bridge";
+    status: "answerChanged";
+    question: string;
+    id?: string | undefined;
+    answer?: unknown;
+}>;
+export declare const responseSuccessMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    id?: string | undefined;
+}>;
+export declare const responseErrorMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"error">;
+    message: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "error";
+    message: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "error";
+    message: string;
+    id?: string | undefined;
+}>;
+export declare const questionSchema: z.ZodObject<{
+    semanticColor: z.ZodOptional<z.ZodString>;
+    label: z.ZodString;
+    description: z.ZodString;
+    disabled: z.ZodBoolean;
+    required: z.ZodBoolean;
+    hidden: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    description: string;
+    disabled: boolean;
+    required: boolean;
+    hidden: boolean;
+    semanticColor?: string | undefined;
+}, {
+    label: string;
+    description: string;
+    disabled: boolean;
+    required: boolean;
+    hidden: boolean;
+    semanticColor?: string | undefined;
+}>;
+export declare const questionOptionalScheme: z.ZodObject<{
+    semanticColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    label: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    semanticColor?: string | undefined;
+    label?: string | undefined;
+    description?: string | undefined;
+    disabled?: boolean | undefined;
+    required?: boolean | undefined;
+    hidden?: boolean | undefined;
+}, {
+    semanticColor?: string | undefined;
+    label?: string | undefined;
+    description?: string | undefined;
+    disabled?: boolean | undefined;
+    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>;
+}, {
+    action: z.ZodLiteral<"getQuestion">;
+    question: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    question: string;
+    action: "getQuestion";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    question: string;
+    action: "getQuestion";
+    id?: string | undefined;
+}>;
+export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, {
+    question: z.ZodObject<{
+        semanticColor: z.ZodOptional<z.ZodString>;
+        label: z.ZodString;
+        description: z.ZodString;
+        disabled: z.ZodBoolean;
+        required: z.ZodBoolean;
+        hidden: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        description: string;
+        disabled: boolean;
+        required: boolean;
+        hidden: boolean;
+        semanticColor?: string | undefined;
+    }, {
+        label: string;
+        description: string;
+        disabled: boolean;
+        required: boolean;
+        hidden: boolean;
+        semanticColor?: string | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    question: {
+        label: string;
+        description: string;
+        disabled: boolean;
+        required: boolean;
+        hidden: boolean;
+        semanticColor?: string | undefined;
+    };
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    question: {
+        label: string;
+        description: string;
+        disabled: boolean;
+        required: boolean;
+        hidden: boolean;
+        semanticColor?: string | undefined;
+    };
+    id?: string | undefined;
+}>;
+export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"setQuestion">;
+    question: z.ZodString;
+    questionData: z.ZodObject<{
+        semanticColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        label: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        hidden: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        semanticColor?: string | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        disabled?: boolean | undefined;
+        required?: boolean | undefined;
+        hidden?: boolean | undefined;
+    }, {
+        semanticColor?: string | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        disabled?: boolean | undefined;
+        required?: boolean | undefined;
+        hidden?: boolean | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    question: string;
+    action: "setQuestion";
+    questionData: {
+        semanticColor?: string | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        disabled?: boolean | undefined;
+        required?: boolean | undefined;
+        hidden?: boolean | undefined;
+    };
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    question: string;
+    action: "setQuestion";
+    questionData: {
+        semanticColor?: string | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        disabled?: boolean | undefined;
+        required?: boolean | undefined;
+        hidden?: boolean | undefined;
+    };
+    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>;
+}, {
+    action: z.ZodLiteral<"setAnswer">;
+    question: z.ZodString;
+    answer: z.ZodUnknown;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    question: string;
+    action: "setAnswer";
+    id?: string | undefined;
+    answer?: unknown;
+}, {
+    type: "qp-bridge";
+    question: string;
+    action: "setAnswer";
+    id?: string | undefined;
+    answer?: unknown;
+}>;
+export type QpBridgeMessage = z.infer<typeof qpBridgeMessageSchema>;
+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;
+export declare function isSuccessMessage(data: unknown): data is ResponseSuccessMessage;
+export declare function isErrorMessage(data: unknown): data is ResponseErrorMessage;
+export declare function isGetQuestionRequestMessage(data: unknown): data is GetQuestionRequestMessage;
+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

@@ -0,0 +1,76 @@
+import { Group, Question, QuestionOptional } from './qp-bridge-types';
+/**
+ * Sets the answer for a specific question in the questionnaire.
+ *
+ * @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.
+ * @example
+ * ```typescript
+ * await setAnswer('favoriteColor', 'blue');
+ * ```
+ * @see onAnswerChange
+ */
+export declare function setAnswer(questionName: string, answer: unknown): Promise<void>;
+/**
+ * Retrieves a question by its name from the questionnaire.
+ *
+ * @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.
+ * @example
+ * ```typescript
+ * const question = await getQuestion('favoriteColor');
+ * console.log(question.label); // Outputs the label of the question
+ * ```
+ */
+export declare function getQuestion(name: string): Promise<Question>;
+/**
+ * Updates a question in the questionnaire.
+ *
+ * @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.
+ * @example
+ * ```typescript
+ * await setQuestion('favoriteColor', { label: 'What is your favorite color?' });
+ * ```
+ */
+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
+ * and invokes the provided listener whenever an answer changes.
+ * @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) => {
+ *  console.log(`Answer for ${question} changed to:`, answer);
+ *  });
+ *
+ * // To stop listening for changes:
+ * cancelSubscription();
+ * ```
+ **/
+export declare function onAnswerChange(listener: (question: string, answer: unknown) => void): {
+    cancelSubscription: () => void;
+};

package/package.json

@@ -0,0 +1,11 @@
+{
+	"name": "@resconet/qp-bridge",
+	"version": "0.0.1-alpha.10",
+	"dependencies": {
+		"zod": "^3.23.8",
+		"uuid": "^9.0.1"
+	},
+	"main": "./index.js",
+	"module": "./index.mjs",
+	"typings": "./index.d.ts"
+}