@resconet/qp-bridge 0.0.1-alpha.19 → 0.0.1-alpha.21

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

@@ -126,6 +126,7 @@ export declare const mediaItemSchema: z.ZodObject<{
     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;
@@ -507,6 +508,136 @@ export declare const executeCustomCommandRequestMessageSchema: z.ZodObject<z.obj
     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>;
@@ -515,10 +646,13 @@ 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>;
@@ -530,6 +664,11 @@ export type SaveQuestionnaireRequestMessage = z.infer<typeof saveQuestionnaireRe
 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;
@@ -551,3 +690,10 @@ export declare function isSaveQuestionnaireRequestMessage(data: unknown): data i
 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 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;

package/lib/qp-bridge.d.ts

@@ -1,4 +1,4 @@
-import { Group, GroupOptional, MediaItem, Question, QuestionOptional } from './qp-bridge-types';
+import { Entity, Group, GroupOptional, MediaItem, Question, QuestionOptional } from './qp-bridge-types';
 /**
  * Creates a MediaItem from the provided parameters and content.
  *
@@ -232,4 +232,81 @@ type Validator = () => Promise<boolean>;
 export declare function onSave(validator: Validator): {
     cancelSubscription: () => void;
 };
+/**
+ * Fetches entities from the CRM system using the provided FetchXML query.
+ *
+ * @param {string} fetchXml - The FetchXML query string to execute.
+ * @returns {Promise<Entity[]>} A promise that resolves to an array of entities.
+ * @throws {Error} Throws if the fetch operation fails or if no entities are found.
+ * @example
+ * ```typescript
+ * const fetchXml = `<fetch top="10">
+ *   <entity name="contact">
+ *     <attribute name="firstname" />
+ *     <attribute name="lastname" />
+ *   </entity>
+ * </fetch>`;
+ * const entities = await fetchEntities(fetchXml);
+ * console.log(entities); // Array of contact entities
+ * ```
+ */
+export declare function fetchEntities(fetchXml: string): Promise<Entity[]>;
+/**
+ * Retrieves a single entity by its name and ID from the CRM system.
+ *
+ * @param {string} entityName - The name of the entity to retrieve (e.g., "contact", "account").
+ * @param {string} id - The unique identifier of the entity.
+ * @returns {Promise<Entity>} A promise that resolves to the entity object.
+ * @throws {Error} Throws if the entity is not found or the operation fails.
+ * @example
+ * ```typescript
+ * const contact = await getEntityById('contact', '12345678-1234-1234-1234-123456789abc');
+ * console.log(contact.attributes.firstname); // Entity firstname attribute
+ * ```
+ */
+export declare function getEntityById(entityName: string, id: string): Promise<Entity>;
+/**
+ * Repeats a specific group within a repeatable group by creating a copy of the group at the specified index.
+ * The parent group must be a repeatable group and the index must refer to an existing group instance.
+ *
+ * @param {string} parentGroupName - The name of the parent repeatable group.
+ * @param {number} groupIndex - The index (0-based) of the group instance to repeat.
+ * @returns {Promise<void>} A promise that resolves when the group has been successfully repeated.
+ * @throws {Error} Throws if the parent group is not found, is not a repeatable group, the index is invalid, or the operation fails.
+ * @example
+ * ```typescript
+ * await repeatGroup('personalInfoRepeatable', 1);
+ * console.log('Group repeated successfully');
+ * ```
+ */
+export declare function repeatGroup(parentGroupName: string, groupIndex: number): Promise<void>;
+/**
+ * Adds a new group instance to a repeatable group.
+ * The specified name must refer to a repeatable group.
+ *
+ * @param {string} name - The name of the repeatable group to add a new instance to.
+ * @returns {Promise<void>} A promise that resolves when the new group has been successfully added.
+ * @throws {Error} Throws if the repeatable group is not found or the operation fails.
+ * @example
+ * ```typescript
+ * await addNewGroup('personalInfoRepeatable');
+ * console.log('New group added successfully');
+ * ```
+ */
+export declare function addNewGroup(name: string): Promise<void>;
+/**
+ * Deletes a specific group instance from a repeatable group by index.
+ * The parent group must be a repeatable group and the index must refer to an existing group instance.
+ *
+ * @param {string} parentGroupName - The name of the parent repeatable group.
+ * @param {number} groupIndex - The index (0-based) of the group instance to delete.
+ * @returns {Promise<void>} A promise that resolves when the group has been successfully deleted.
+ * @throws {Error} Throws if the parent group is not found, is not a repeatable group, the index is invalid, or the operation fails.
+ * @example
+ * ```typescript
+ * await deleteGroup('personalInfoRepeatable', 1);
+ * console.log('Group deleted successfully');
+ * ```
+ */
+export declare function deleteGroup(parentGroupName: string, groupIndex: number): Promise<void>;
 export {};

package/package.json

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