@resconet/qp-bridge 0.0.1-alpha.5

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

@@ -0,0 +1,157 @@
+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<{
+    label: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    name: string;
+}, {
+    label: string;
+    name: string;
+}>;
+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<{
+        label: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        name: string;
+    }, {
+        label: string;
+        name: string;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    question: {
+        label: string;
+        name: string;
+    };
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    question: {
+        label: string;
+        name: string;
+    };
+    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 OnAnswerChangeMessage = z.infer<typeof onAnswerChangeMessageSchema>;
+export type GetQuestionSuccessResponseMessage = z.infer<typeof getQuestionSuccessResponseMessageSchema>;
+export type SetAnswerRequestMessage = z.infer<typeof setAnswerRequestMessageSchema>;
+export type GetQuestionRequestMessage = z.infer<typeof getQuestionRequestMessageSchema>;
+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;

package/lib/qp-bridge.d.ts

@@ -0,0 +1,48 @@
+import { Question } 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>;
+/**
+ * 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,10 @@
+{
+	"name": "@resconet/qp-bridge",
+	"version": "0.0.1-alpha.5",
+	"dependencies": {
+		"zod": "^3.23.8"
+	},
+	"main": "./index.js",
+	"module": "./index.mjs",
+	"typings": "./index.d.ts"
+}