@resconet/qp-bridge 1.3.2-alpha.3 → 1.3.2-alpha.4

package/lib/qp-bridge.d.ts

@@ -1,4 +1,7 @@
 import { Entity, Group, GroupOptional, MediaItem, Question, QuestionOptional } from './qp-bridge-types';
+export type QpBridgeOptions = {
+    instanceId?: string;
+};
 /**
  * Creates a MediaItem from the provided parameters and content.
  *
@@ -79,7 +82,7 @@ export declare function removeOnSaveMessageHandler(): void;
  * ```
  * @see onAnswerChange
  */
-export declare function setAnswer(questionName: string, answer: unknown): Promise<void>;
+export declare function setAnswer(questionName: string, answer: unknown, options?: QpBridgeOptions): Promise<void>;
 /**
  * Retrieves a question by its name from the questionnaire.
  *
@@ -92,7 +95,7 @@ export declare function setAnswer(questionName: string, answer: unknown): Promis
  * console.log(question.label); // Outputs the label of the question
  * ```
  */
-export declare function getQuestion(name: string): Promise<Question>;
+export declare function getQuestion(name: string, options?: QpBridgeOptions): Promise<Question>;
 /**
  * Updates a question in the questionnaire.
  *
@@ -105,7 +108,7 @@ export declare function getQuestion(name: string): Promise<Question>;
  * await setQuestion('favoriteColor', { label: 'What is your favorite color?' });
  * ```
  */
-export declare function setQuestion(name: string, questionData: QuestionOptional): Promise<void>;
+export declare function setQuestion(name: string, questionData: QuestionOptional, options?: QpBridgeOptions): Promise<void>;
 /**
  * Retrieves a group by its name from the questionnaire.
  *
@@ -120,7 +123,7 @@ export declare function setQuestion(name: string, questionData: QuestionOptional
  * console.log(group.collapsed); // Outputs whether the group is collapsed
  * ```
  */
-export declare function getGroup(name: string): Promise<Group>;
+export declare function getGroup(name: string, options?: QpBridgeOptions): Promise<Group>;
 /**
  * Updates a group in the questionnaire.
  *
@@ -133,7 +136,7 @@ export declare function getGroup(name: string): Promise<Group>;
  * await setGroup('personalInfo', { label: 'Personal Information', hidden: false, collapsed: true });
  * ```
  */
-export declare function setGroup(name: string, groupData: GroupOptional): Promise<void>;
+export declare function setGroup(name: string, groupData: GroupOptional, options?: QpBridgeOptions): Promise<void>;
 /**
  * Subscribes to changes in answers for questions.
  * Calls the provided listener whenever an answer changes in the questionnaire.
@@ -150,7 +153,7 @@ export declare function setGroup(name: string, groupData: GroupOptional): Promis
  * cancelSubscription();
  * ```
  **/
-export declare function onAnswerChange(listener: (question: string, answer: unknown) => void): {
+export declare function onAnswerChange(listener: (question: string, answer: unknown) => void, options?: QpBridgeOptions): {
     cancelSubscription: () => void;
 };
 /**
@@ -171,7 +174,7 @@ export declare function onAnswerChange(listener: (question: string, answer: unkn
  * console.log(result); // 'done'
  * ```
  */
-export declare function withBusyIndicator<T>(action: () => Promise<T>): Promise<T>;
+export declare function withBusyIndicator<T>(action: () => Promise<T>, options?: QpBridgeOptions): Promise<T>;
 /**
  * Saves the current questionnaire state.
  * Triggers a save operation for the questionnaire data.
@@ -184,7 +187,7 @@ export declare function withBusyIndicator<T>(action: () => Promise<T>): Promise<
  * console.log('Questionnaire saved successfully');
  * ```
  */
-export declare function saveQuestionnaire(): Promise<void>;
+export declare function saveQuestionnaire(options?: QpBridgeOptions): Promise<void>;
 /**
  * Completes and closes the current questionnaire.
  * Triggers the complete and close operation for the questionnaire.
@@ -197,7 +200,7 @@ export declare function saveQuestionnaire(): Promise<void>;
  * console.log('Questionnaire completed and closed successfully');
  * ```
  */
-export declare function completeAndCloseQuestionnaire(): Promise<void>;
+export declare function completeAndCloseQuestionnaire(options?: QpBridgeOptions): Promise<void>;
 /**
  * Executes a custom command by its name.
  * Triggers the execution of any user-defined command in the questionnaire.
@@ -211,7 +214,7 @@ export declare function completeAndCloseQuestionnaire(): Promise<void>;
  * console.log('Custom command executed successfully');
  * ```
  */
-export declare function executeCustomCommand(commandName: string): Promise<void>;
+export declare function executeCustomCommand(commandName: string, options?: QpBridgeOptions): Promise<void>;
 type Validator = () => Promise<boolean>;
 /**
  * Registers a handler function to be called when the questionnaire is fully loaded.
@@ -230,7 +233,7 @@ type Validator = () => Promise<boolean>;
  * cancelSubscription();
  * ```
  */
-export declare function onQuestionnaireLoaded(handler: () => void): {
+export declare function onQuestionnaireLoaded(handler: () => void, options?: QpBridgeOptions): {
     cancelSubscription: () => void;
 };
 /**
@@ -250,7 +253,7 @@ export declare function onQuestionnaireLoaded(handler: () => void): {
  * cancelSubscription();
  * ```
  */
-export declare function onCommandExecuted(handler: (commandName: string) => void): {
+export declare function onCommandExecuted(handler: (commandName: string) => void, options?: QpBridgeOptions): {
     cancelSubscription: () => void;
 };
 /**
@@ -271,7 +274,7 @@ export declare function onCommandExecuted(handler: (commandName: string) => void
  * cancelSubscription();
  * ```
  */
-export declare function onSave(validator: Validator): {
+export declare function onSave(validator: Validator, options?: QpBridgeOptions): {
     cancelSubscription: () => void;
 };
 /**
@@ -292,7 +295,7 @@ export declare function onSave(validator: Validator): {
  * console.log(entities); // Array of contact entities
  * ```
  */
-export declare function fetchEntities(fetchXml: string): Promise<Entity[]>;
+export declare function fetchEntities(fetchXml: string, options?: QpBridgeOptions): Promise<Entity[]>;
 /**
  * Retrieves a single entity by its name and ID from the CRM system.
  *
@@ -306,7 +309,7 @@ export declare function fetchEntities(fetchXml: string): Promise<Entity[]>;
  * console.log(contact.attributes.firstname); // Entity firstname attribute
  * ```
  */
-export declare function getEntityById(entityName: string, id: string): Promise<Entity>;
+export declare function getEntityById(entityName: string, id: string, options?: QpBridgeOptions): Promise<Entity>;
 /**
  * Creates a new entity marker that can be enriched before saving.
  * The returned entity is flagged with `isNew` so the host can distinguish new records.
@@ -316,7 +319,7 @@ export declare function createNewEntity(): Entity;
  * Persists an entity through the bridge. Supports both new and existing entities.
  * @param entity - Entity payload; include `isNew` for newly created entities.
  */
-export declare function saveEntity(entity: Entity): Promise<void>;
+export declare function saveEntity(entity: Entity, options?: QpBridgeOptions): Promise<void>;
 /**
  * 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.
@@ -331,7 +334,7 @@ export declare function saveEntity(entity: Entity): Promise<void>;
  * console.log('Group repeated successfully');
  * ```
  */
-export declare function repeatGroup(repeatableGroupName: string, groupIndex: number): Promise<void>;
+export declare function repeatGroup(repeatableGroupName: string, groupIndex: number, options?: QpBridgeOptions): Promise<void>;
 /**
  * Adds a new group instance to a repeatable group.
  * The specified name must refer to a repeatable group.
@@ -345,7 +348,7 @@ export declare function repeatGroup(repeatableGroupName: string, groupIndex: num
  * console.log('New group added successfully');
  * ```
  */
-export declare function addNewGroup(repeatableGroupName: string): Promise<void>;
+export declare function addNewGroup(repeatableGroupName: string, options?: QpBridgeOptions): 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.
@@ -360,5 +363,5 @@ export declare function addNewGroup(repeatableGroupName: string): Promise<void>;
  * console.log('Group deleted successfully');
  * ```
  */
-export declare function deleteGroup(repeatableGroupName: string, groupIndex: number): Promise<void>;
+export declare function deleteGroup(repeatableGroupName: string, groupIndex: number, options?: QpBridgeOptions): Promise<void>;
 export {};

package/package.json

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