@resconet/qp-bridge 0.0.1-alpha.9 → 1.0.0

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

@@ -67,20 +67,26 @@ export declare const questionSchema: z.ZodObject<{
     disabled: z.ZodBoolean;
     required: z.ZodBoolean;
     hidden: z.ZodBoolean;
+    errorMessage: z.ZodOptional<z.ZodString>;
+    answer: z.ZodOptional<z.ZodUnknown>;
 }, "strip", z.ZodTypeAny, {
     label: string;
     description: string;
     disabled: boolean;
     required: boolean;
     hidden: boolean;
+    answer?: unknown;
     semanticColor?: string | undefined;
+    errorMessage?: string | undefined;
 }, {
     label: string;
     description: string;
     disabled: boolean;
     required: boolean;
     hidden: boolean;
+    answer?: unknown;
     semanticColor?: string | undefined;
+    errorMessage?: string | undefined;
 }>;
 export declare const questionOptionalScheme: z.ZodObject<{
     semanticColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -89,21 +95,44 @@ export declare const questionOptionalScheme: z.ZodObject<{
     disabled: z.ZodOptional<z.ZodBoolean>;
     required: z.ZodOptional<z.ZodBoolean>;
     hidden: z.ZodOptional<z.ZodBoolean>;
+    errorMessage: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    answer: z.ZodOptional<z.ZodOptional<z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
+    answer?: unknown;
     semanticColor?: string | undefined;
     label?: string | undefined;
     description?: string | undefined;
     disabled?: boolean | undefined;
     required?: boolean | undefined;
     hidden?: boolean | undefined;
+    errorMessage?: string | undefined;
 }, {
+    answer?: unknown;
     semanticColor?: string | undefined;
     label?: string | undefined;
     description?: string | undefined;
     disabled?: boolean | undefined;
     required?: boolean | undefined;
     hidden?: boolean | undefined;
+    errorMessage?: string | undefined;
+}>;
+export declare const mediaItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    mimeType: z.ZodString;
+    blobUrl: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    mimeType: string;
+    blobUrl: string;
+}, {
+    id: string;
+    name: string;
+    mimeType: string;
+    blobUrl: string;
 }>;
+export declare const entitySchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 export declare const groupSchema: z.ZodObject<{
     label: z.ZodString;
     hidden: z.ZodBoolean;
@@ -160,20 +189,26 @@ export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.obje
         disabled: z.ZodBoolean;
         required: z.ZodBoolean;
         hidden: z.ZodBoolean;
+        errorMessage: z.ZodOptional<z.ZodString>;
+        answer: z.ZodOptional<z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         label: string;
         description: string;
         disabled: boolean;
         required: boolean;
         hidden: boolean;
+        answer?: unknown;
         semanticColor?: string | undefined;
+        errorMessage?: string | undefined;
     }, {
         label: string;
         description: string;
         disabled: boolean;
         required: boolean;
         hidden: boolean;
+        answer?: unknown;
         semanticColor?: string | undefined;
+        errorMessage?: string | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
@@ -184,7 +219,9 @@ export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.obje
         disabled: boolean;
         required: boolean;
         hidden: boolean;
+        answer?: unknown;
         semanticColor?: string | undefined;
+        errorMessage?: string | undefined;
     };
     id?: string | undefined;
 }, {
@@ -196,7 +233,9 @@ export declare const getQuestionSuccessResponseMessageSchema: z.ZodObject<z.obje
         disabled: boolean;
         required: boolean;
         hidden: boolean;
+        answer?: unknown;
         semanticColor?: string | undefined;
+        errorMessage?: string | undefined;
     };
     id?: string | undefined;
 }>;
@@ -213,32 +252,40 @@ export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
         disabled: z.ZodOptional<z.ZodBoolean>;
         required: z.ZodOptional<z.ZodBoolean>;
         hidden: z.ZodOptional<z.ZodBoolean>;
+        errorMessage: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        answer: z.ZodOptional<z.ZodOptional<z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
+        answer?: unknown;
         semanticColor?: string | undefined;
         label?: string | undefined;
         description?: string | undefined;
         disabled?: boolean | undefined;
         required?: boolean | undefined;
         hidden?: boolean | undefined;
+        errorMessage?: string | undefined;
     }, {
+        answer?: unknown;
         semanticColor?: string | undefined;
         label?: string | undefined;
         description?: string | undefined;
         disabled?: boolean | undefined;
         required?: boolean | undefined;
         hidden?: boolean | undefined;
+        errorMessage?: string | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
     type: "qp-bridge";
     question: string;
     action: "setQuestion";
     questionData: {
+        answer?: unknown;
         semanticColor?: string | undefined;
         label?: string | undefined;
         description?: string | undefined;
         disabled?: boolean | undefined;
         required?: boolean | undefined;
         hidden?: boolean | undefined;
+        errorMessage?: string | undefined;
     };
     id?: string | undefined;
 }, {
@@ -246,12 +293,14 @@ export declare const setQuestionRequestMessageSchema: z.ZodObject<z.objectUtil.e
     question: string;
     action: "setQuestion";
     questionData: {
+        answer?: unknown;
         semanticColor?: string | undefined;
         label?: string | undefined;
         description?: string | undefined;
         disabled?: boolean | undefined;
         required?: boolean | undefined;
         hidden?: boolean | undefined;
+        errorMessage?: string | undefined;
     };
     id?: string | undefined;
 }>;
@@ -310,6 +359,78 @@ export declare const getGroupSuccessResponseMessageSchema: z.ZodObject<z.objectU
     };
     id?: string | undefined;
 }>;
+export declare const canSaveSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, {
+    canSave: z.ZodBoolean;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    canSave: boolean;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    canSave: boolean;
+    id?: string | undefined;
+}>;
+export declare const canSaveRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"canSave">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "canSave";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "canSave";
+    id?: string | undefined;
+}>;
+export declare const setGroupRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"setGroup">;
+    group: z.ZodString;
+    groupData: 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;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "setGroup";
+    group: string;
+    groupData: {
+        label?: string | undefined;
+        hidden?: boolean | undefined;
+        collapsed?: boolean | undefined;
+    };
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "setGroup";
+    group: string;
+    groupData: {
+        label?: string | undefined;
+        hidden?: boolean | undefined;
+        collapsed?: boolean | undefined;
+    };
+    id?: string | undefined;
+}>;
 export declare const setAnswerRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodLiteral<"qp-bridge">;
     id: z.ZodOptional<z.ZodString>;
@@ -330,6 +451,209 @@ export declare const setAnswerRequestMessageSchema: z.ZodObject<z.objectUtil.ext
     id?: string | undefined;
     answer?: unknown;
 }>;
+export declare const busyIndicatorStartRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"busyIndicatorStart">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "busyIndicatorStart";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "busyIndicatorStart";
+    id?: string | undefined;
+}>;
+export declare const busyIndicatorEndRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"busyIndicatorEnd">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "busyIndicatorEnd";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "busyIndicatorEnd";
+    id?: string | undefined;
+}>;
+export declare const saveQuestionnaireRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"saveQuestionnaire">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "saveQuestionnaire";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "saveQuestionnaire";
+    id?: string | undefined;
+}>;
+export declare const completeAndCloseQuestionnaireRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"completeAndCloseQuestionnaire">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "completeAndCloseQuestionnaire";
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "completeAndCloseQuestionnaire";
+    id?: string | undefined;
+}>;
+export declare const executeCustomCommandRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"executeCustomCommand">;
+    commandName: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "executeCustomCommand";
+    commandName: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "executeCustomCommand";
+    commandName: string;
+    id?: string | undefined;
+}>;
+export declare const fetchEntitiesRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"fetchEntities">;
+    fetchXml: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "fetchEntities";
+    fetchXml: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "fetchEntities";
+    fetchXml: string;
+    id?: string | undefined;
+}>;
+export declare const fetchEntitiesSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, {
+    entities: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    entities: Record<string, unknown>[];
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    entities: Record<string, unknown>[];
+    id?: string | undefined;
+}>;
+export declare const getEntityByIdRequestMessageSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    action: z.ZodLiteral<"getEntityById">;
+    entityName: z.ZodString;
+    entityId: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    action: "getEntityById";
+    entityName: string;
+    entityId: string;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    action: "getEntityById";
+    entityName: string;
+    entityId: string;
+    id?: string | undefined;
+}>;
+export declare const getEntityByIdSuccessResponseMessageSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    type: z.ZodLiteral<"qp-bridge">;
+    id: z.ZodOptional<z.ZodString>;
+}, {
+    status: z.ZodLiteral<"success">;
+}>, {
+    entity: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}>, "strip", z.ZodTypeAny, {
+    type: "qp-bridge";
+    status: "success";
+    entity: Record<string, unknown>;
+    id?: string | undefined;
+}, {
+    type: "qp-bridge";
+    status: "success";
+    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>;
@@ -337,13 +661,32 @@ 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 MediaItem = z.infer<typeof mediaItemSchema>;
+export type Entity = z.infer<typeof entitySchema>;
 export type OnAnswerChangeMessage = z.infer<typeof onAnswerChangeMessageSchema>;
 export type GetQuestionSuccessResponseMessage = z.infer<typeof getQuestionSuccessResponseMessageSchema>;
 export type GetGroupSuccessResponseMessage = z.infer<typeof getGroupSuccessResponseMessageSchema>;
+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 SetQuestionRequestMessage = z.infer<typeof setQuestionRequestMessageSchema>;
+export type SetGroupRequestMessage = z.infer<typeof setGroupRequestMessageSchema>;
+export type BusyIndicatorStartRequestMessage = z.infer<typeof busyIndicatorStartRequestMessageSchema>;
+export type BusyIndicatorEndRequestMessage = z.infer<typeof busyIndicatorEndRequestMessageSchema>;
+export type SaveQuestionnaireRequestMessage = z.infer<typeof saveQuestionnaireRequestMessageSchema>;
+export type CompleteAndCloseQuestionnaireRequestMessage = z.infer<typeof completeAndCloseQuestionnaireRequestMessageSchema>;
+export type ExecuteCustomCommandRequestMessage = z.infer<typeof executeCustomCommandRequestMessageSchema>;
+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;
 export declare function isQpBridgeMessage(data: unknown): data is QpBridgeMessage;
 export declare function isSuccessMessage(data: unknown): data is ResponseSuccessMessage;
@@ -352,5 +695,22 @@ 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 isSetGroupRequestMessage(data: unknown): data is SetGroupRequestMessage;
 export declare function isGetGroupRequestMessage(data: unknown): data is GetGroupRequestMessage;
 export declare function isGetGroupSuccessResponseMessage(data: unknown): data is GetGroupSuccessResponseMessage;
+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;
+export declare function isBusyIndicatorEndRequestMessage(data: unknown): data is BusyIndicatorEndRequestMessage;
+export declare function isSaveQuestionnaireRequestMessage(data: unknown): data is SaveQuestionnaireRequestMessage;
+export declare function isCompleteAndCloseQuestionnaireRequestMessage(data: unknown): data is CompleteAndCloseQuestionnaireRequestMessage;
+export declare function isExecuteCustomCommandRequestMessage(data: unknown): data is ExecuteCustomCommandRequestMessage;
+export declare function isWithBusyIndicatorRequestMessage(data: unknown): data is WithBusyIndicatorRequestMessage;
+export declare function isNotRelevantMessage(data: unknown, id: string): boolean;
+export declare function isFetchEntitiesRequestMessage(data: unknown): data is FetchEntitiesRequestMessage;
+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;