@resconet/qp-bridge 1.3.2-alpha.4 → 1.4.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -19
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -412,7 +412,7 @@ Sets the answer for a specific question in the questionnaire.
412
412
 
413
413
  | Function | Type |
414
414
  | ---------- | ---------- |
415
- | `setAnswer` | `(questionName: string, answer: unknown) => Promise<void>` |
415
+ | `setAnswer` | `(questionName: string, answer: unknown, options?: QpBridgeOptions or undefined) => Promise<void>` |
416
416
 
417
417
  Parameters:
418
418
 
@@ -442,7 +442,7 @@ Retrieves a question by its name from the questionnaire.
442
442
 
443
443
  | Function | Type |
444
444
  | ---------- | ---------- |
445
- | `getQuestion` | `(name: string) => Promise<{ label: string; description: string; disabled: boolean; required: boolean; hidden: boolean; semanticColor?: string or undefined; errorMessage?: string or undefined; answer?: unknown; }>` |
445
+ | `getQuestion` | `(name: string, options?: QpBridgeOptions or undefined) => Promise<{ label: string; description: string; disabled: boolean; required: boolean; hidden: boolean; semanticColor?: string or undefined; errorMessage?: string or undefined; answer?: unknown; }>` |
446
446
 
447
447
  Parameters:
448
448
 
@@ -467,7 +467,7 @@ Updates a question in the questionnaire.
467
467
 
468
468
  | Function | Type |
469
469
  | ---------- | ---------- |
470
- | `setQuestion` | `(name: string, questionData: { semanticColor?: string or undefined; label?: string or undefined; description?: string or undefined; disabled?: boolean or undefined; required?: boolean or undefined; hidden?: boolean or undefined; errorMessage?: string or undefined; answer?: unknown; }) => Promise<...>` |
470
+ | `setQuestion` | `(name: string, questionData: { semanticColor?: string or undefined; label?: string or undefined; description?: string or undefined; disabled?: boolean or undefined; required?: boolean or undefined; hidden?: boolean or undefined; errorMessage?: string or undefined; answer?: unknown; }, options?: QpBridgeOptions or undefined)...` |
471
471
 
472
472
  Parameters:
473
473
 
@@ -492,7 +492,7 @@ Retrieves a group by its name from the questionnaire.
492
492
 
493
493
  | Function | Type |
494
494
  | ---------- | ---------- |
495
- | `getGroup` | `(name: string) => Promise<{ label: string; hidden: boolean; collapsed: boolean; }>` |
495
+ | `getGroup` | `(name: string, options?: QpBridgeOptions or undefined) => Promise<{ label: string; hidden: boolean; collapsed: boolean; }>` |
496
496
 
497
497
  Parameters:
498
498
 
@@ -519,7 +519,7 @@ Updates a group in the questionnaire.
519
519
 
520
520
  | Function | Type |
521
521
  | ---------- | ---------- |
522
- | `setGroup` | `(name: string, groupData: { label?: string or undefined; hidden?: boolean or undefined; collapsed?: boolean or undefined; }) => Promise<void>` |
522
+ | `setGroup` | `(name: string, groupData: { label?: string or undefined; hidden?: boolean or undefined; collapsed?: boolean or undefined; }, options?: QpBridgeOptions or undefined) => Promise<...>` |
523
523
 
524
524
  Parameters:
525
525
 
@@ -545,7 +545,7 @@ Calls the provided listener whenever an answer changes in the questionnaire.
545
545
 
546
546
  | Function | Type |
547
547
  | ---------- | ---------- |
548
- | `onAnswerChange` | `(listener: (question: string, answer: unknown) => void) => { cancelSubscription: () => void; }` |
548
+ | `onAnswerChange` | `(listener: (question: string, answer: unknown) => void, options?: QpBridgeOptions or undefined) => { cancelSubscription: () => void; }` |
549
549
 
550
550
  Parameters:
551
551
 
@@ -573,7 +573,7 @@ ensuring the UI reflects the busy state appropriately.
573
573
 
574
574
  | Function | Type |
575
575
  | ---------- | ---------- |
576
- | `withBusyIndicator` | `<T>(action: () => Promise<T>) => Promise<T>` |
576
+ | `withBusyIndicator` | `<T>(action: () => Promise<T>, options?: QpBridgeOptions or undefined) => Promise<T>` |
577
577
 
578
578
  Parameters:
579
579
 
@@ -602,7 +602,7 @@ Triggers a save operation for the questionnaire data.
602
602
 
603
603
  | Function | Type |
604
604
  | ---------- | ---------- |
605
- | `saveQuestionnaire` | `() => Promise<void>` |
605
+ | `saveQuestionnaire` | `(options?: QpBridgeOptions or undefined) => Promise<void>` |
606
606
 
607
607
  Returns:
608
608
 
@@ -623,7 +623,7 @@ Triggers the complete and close operation for the questionnaire.
623
623
 
624
624
  | Function | Type |
625
625
  | ---------- | ---------- |
626
- | `completeAndCloseQuestionnaire` | `() => Promise<void>` |
626
+ | `completeAndCloseQuestionnaire` | `(options?: QpBridgeOptions or undefined) => Promise<void>` |
627
627
 
628
628
  Returns:
629
629
 
@@ -644,7 +644,7 @@ Triggers the execution of any user-defined command in the questionnaire.
644
644
 
645
645
  | Function | Type |
646
646
  | ---------- | ---------- |
647
- | `executeCustomCommand` | `(commandName: string) => Promise<void>` |
647
+ | `executeCustomCommand` | `(commandName: string, options?: QpBridgeOptions or undefined) => Promise<void>` |
648
648
 
649
649
  Parameters:
650
650
 
@@ -670,7 +670,7 @@ Useful for performing actions that depend on the questionnaire being ready.
670
670
 
671
671
  | Function | Type |
672
672
  | ---------- | ---------- |
673
- | `onQuestionnaireLoaded` | `(handler: () => void) => { cancelSubscription: () => void; }` |
673
+ | `onQuestionnaireLoaded` | `(handler: () => void, options?: QpBridgeOptions or undefined) => { cancelSubscription: () => void; }` |
674
674
 
675
675
  Parameters:
676
676
 
@@ -701,7 +701,7 @@ Useful for reacting to custom command executions within the questionnaire.
701
701
 
702
702
  | Function | Type |
703
703
  | ---------- | ---------- |
704
- | `onCommandExecuted` | `(handler: (commandName: string) => void) => { cancelSubscription: () => void; }` |
704
+ | `onCommandExecuted` | `(handler: (commandName: string) => void, options?: QpBridgeOptions or undefined) => { cancelSubscription: () => void; }` |
705
705
 
706
706
  Parameters:
707
707
 
@@ -732,7 +732,7 @@ Useful for validating data before saving the questionnaire.
732
732
 
733
733
  | Function | Type |
734
734
  | ---------- | ---------- |
735
- | `onSave` | `(validator: Validator) => { cancelSubscription: () => void; }` |
735
+ | `onSave` | `(validator: Validator, options?: QpBridgeOptions or undefined) => { cancelSubscription: () => void; }` |
736
736
 
737
737
  Parameters:
738
738
 
@@ -763,7 +763,7 @@ Fetches entities from the CRM system using the provided FetchXML query.
763
763
 
764
764
  | Function | Type |
765
765
  | ---------- | ---------- |
766
- | `fetchEntities` | `(fetchXml: string) => Promise<Record<string, unknown>[]>` |
766
+ | `fetchEntities` | `(fetchXml: string, options?: QpBridgeOptions or undefined) => Promise<Record<string, unknown>[]>` |
767
767
 
768
768
  Parameters:
769
769
 
@@ -794,7 +794,7 @@ Retrieves a single entity by its name and ID from the CRM system.
794
794
 
795
795
  | Function | Type |
796
796
  | ---------- | ---------- |
797
- | `getEntityById` | `(entityName: string, id: string) => Promise<Record<string, unknown>>` |
797
+ | `getEntityById` | `(entityName: string, id: string, options?: QpBridgeOptions or undefined) => Promise<Record<string, unknown>>` |
798
798
 
799
799
  Parameters:
800
800
 
@@ -829,7 +829,7 @@ Persists an entity through the bridge. Supports both new and existing entities.
829
829
 
830
830
  | Function | Type |
831
831
  | ---------- | ---------- |
832
- | `saveEntity` | `(entity: Record<string, unknown>) => Promise<void>` |
832
+ | `saveEntity` | `(entity: Record<string, unknown>, options?: QpBridgeOptions or undefined) => Promise<void>` |
833
833
 
834
834
  Parameters:
835
835
 
@@ -843,7 +843,7 @@ The parent group must be a repeatable group and the index must refer to an exist
843
843
 
844
844
  | Function | Type |
845
845
  | ---------- | ---------- |
846
- | `repeatGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
846
+ | `repeatGroup` | `(repeatableGroupName: string, groupIndex: number, options?: QpBridgeOptions or undefined) => Promise<void>` |
847
847
 
848
848
  Parameters:
849
849
 
@@ -870,7 +870,7 @@ The specified name must refer to a repeatable group.
870
870
 
871
871
  | Function | Type |
872
872
  | ---------- | ---------- |
873
- | `addNewGroup` | `(repeatableGroupName: string) => Promise<void>` |
873
+ | `addNewGroup` | `(repeatableGroupName: string, options?: QpBridgeOptions or undefined) => Promise<void>` |
874
874
 
875
875
  Parameters:
876
876
 
@@ -896,7 +896,7 @@ The parent group must be a repeatable group and the index must refer to an exist
896
896
 
897
897
  | Function | Type |
898
898
  | ---------- | ---------- |
899
- | `deleteGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
899
+ | `deleteGroup` | `(repeatableGroupName: string, groupIndex: number, options?: QpBridgeOptions or undefined) => Promise<void>` |
900
900
 
901
901
  Parameters:
902
902
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resconet/qp-bridge",
3
- "version": "1.3.2-alpha.4",
3
+ "version": "1.4.0-alpha.5",
4
4
  "main": "./index.js",
5
5
  "module": "./index.mjs",
6
6
  "typings": "./index.d.ts",