@nmshd/connector-tui 2.7.0 → 2.9.0

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.
@@ -74,14 +74,14 @@ export class ConnectorTUIBase {
74
74
  const choices = await this.getFileChoices();
75
75
  if (!choices)
76
76
  return;
77
- const result = await prompts({ message: prompt, type: "select", name: "file", choices: choices });
77
+ const result = await prompts({ message: prompt, type: "select", name: "file", choices });
78
78
  return result.file;
79
79
  }
80
80
  async selectFiles(prompt) {
81
81
  const choices = await this.getFileChoices();
82
82
  if (!choices)
83
83
  return;
84
- const result = await prompts({ message: prompt, type: "multiselect", name: "files", choices: choices });
84
+ const result = await prompts({ message: prompt, type: "multiselect", name: "files", choices });
85
85
  return result.files;
86
86
  }
87
87
  async getFileChoices() {
@@ -49,7 +49,7 @@ export function AddAcceptPendingRequests(Base) {
49
49
  items.push({ accept: true });
50
50
  }
51
51
  }
52
- const canAcceptResult = await this.connectorClient.incomingRequests.canAccept(request.id, { items: items });
52
+ const canAcceptResult = await this.connectorClient.incomingRequests.canAccept(request.id, { items });
53
53
  if (canAcceptResult.isError) {
54
54
  console.log(canAcceptResult.error);
55
55
  return;
@@ -59,7 +59,7 @@ export function AddAcceptPendingRequests(Base) {
59
59
  console.log(canAcceptResult.result);
60
60
  return;
61
61
  }
62
- const acceptResult = await this.connectorClient.incomingRequests.accept(request.id, { items: items });
62
+ const acceptResult = await this.connectorClient.incomingRequests.accept(request.id, { items });
63
63
  if (acceptResult.isError) {
64
64
  console.log(acceptResult.error);
65
65
  return;
@@ -63,6 +63,10 @@ export function AddSendRequestByMessage(Base) {
63
63
  title: "AuthenticationRequestItem",
64
64
  value: this.createAuthenticationRequestItem.bind(this),
65
65
  },
66
+ {
67
+ title: "FormFieldRequestItem",
68
+ value: this.createFormFieldRequestItem.bind(this),
69
+ },
66
70
  {
67
71
  title: "FreeTextRequestItem",
68
72
  value: this.createFreeTextRequestItem.bind(this),
@@ -191,11 +195,6 @@ export function AddSendRequestByMessage(Base) {
191
195
  { title: "A third party", value: "thirdParty" },
192
196
  ],
193
197
  },
194
- {
195
- message: "What are the third party addresses? (comma-separated, optional)",
196
- type: "text",
197
- name: "thirdParties",
198
- },
199
198
  ]);
200
199
  const title = result.attributeTitle ?? `A ${result.attributeType} attribute`;
201
200
  const requestItem = {
@@ -205,7 +204,7 @@ export function AddSendRequestByMessage(Base) {
205
204
  "@type": "RelationshipAttributeQuery",
206
205
  owner: result.owner ?? "",
207
206
  attributeCreationHints: {
208
- title: title,
207
+ title,
209
208
  description: result.attributeDescription,
210
209
  confidentiality: RelationshipAttributeConfidentiality.Public,
211
210
  valueType: result.attributeType,
@@ -235,14 +234,18 @@ export function AddSendRequestByMessage(Base) {
235
234
  },
236
235
  {
237
236
  message: "What are the third party addresses? (comma-separated)",
238
- type: "text",
237
+ type: "list",
238
+ separator: ",",
239
239
  name: "thirdParties",
240
+ format: (value) => value.filter((address) => address.length > 0),
241
+ validate: (value) => value
242
+ .split(",")
243
+ .map((address) => address.trim())
244
+ .filter((address) => address.length > 0).length > 0
245
+ ? true
246
+ : "At least one third party must be specified",
240
247
  },
241
248
  ]);
242
- const thirdParties = result.thirdParties
243
- .split(",")
244
- .map((address) => address.trim())
245
- .filter((address) => address.length > 0);
246
249
  const requestItem = {
247
250
  "@type": "ReadAttributeRequestItem",
248
251
  mustBeAccepted: true,
@@ -250,7 +253,7 @@ export function AddSendRequestByMessage(Base) {
250
253
  "@type": "ThirdPartyRelationshipAttributeQuery",
251
254
  owner: result.owner ?? "",
252
255
  key: result.key,
253
- thirdParty: thirdParties,
256
+ thirdParty: result.thirdParties,
254
257
  },
255
258
  };
256
259
  return requestItem;
@@ -600,6 +603,12 @@ export function AddSendRequestByMessage(Base) {
600
603
  type: "text",
601
604
  name: "title",
602
605
  },
606
+ {
607
+ message: "[Optional] Enter a description of the authentication",
608
+ type: "text",
609
+ name: "description",
610
+ format: (value) => (value.length > 0 ? value : undefined),
611
+ },
603
612
  {
604
613
  message: "[Optional] Enter an unique authenticationToken to know which authentication did the user grant",
605
614
  type: "text",
@@ -611,10 +620,260 @@ export function AddSendRequestByMessage(Base) {
611
620
  "@type": "AuthenticationRequestItem",
612
621
  mustBeAccepted: true,
613
622
  title: result.title,
623
+ description: result.description,
614
624
  metadata: result.responseMetadata,
615
625
  };
616
626
  return requestItem;
617
627
  }
628
+ async createFormFieldRequestItem() {
629
+ const result = await prompts([
630
+ {
631
+ message: "Enter a title for the form field",
632
+ type: "text",
633
+ name: "title",
634
+ },
635
+ {
636
+ message: "What kind of form field should be created?",
637
+ type: "select",
638
+ name: "settings",
639
+ choices: [
640
+ {
641
+ title: "Boolean form field",
642
+ value: "BooleanFormFieldSettings",
643
+ },
644
+ {
645
+ title: "Date form field",
646
+ value: "DateFormFieldSettings",
647
+ },
648
+ {
649
+ title: "Double form field",
650
+ value: "DoubleFormFieldSettings",
651
+ },
652
+ {
653
+ title: "Integer form field",
654
+ value: "IntegerFormFieldSettings",
655
+ },
656
+ {
657
+ title: "Rating form field",
658
+ value: "RatingFormFieldSettings",
659
+ },
660
+ {
661
+ title: "Selection form field",
662
+ value: "SelectionFormFieldSettings",
663
+ },
664
+ {
665
+ title: "String form field",
666
+ value: "StringFormFieldSettings",
667
+ },
668
+ ],
669
+ },
670
+ ]);
671
+ switch (result.settings) {
672
+ case "BooleanFormFieldSettings":
673
+ return this.createBooleanFormFieldRequestItem(result.title);
674
+ case "DateFormFieldSettings":
675
+ return this.createDateFormFieldRequestItem(result.title);
676
+ case "DoubleFormFieldSettings":
677
+ return await this.createDoubleFormFieldRequestItem(result.title);
678
+ case "IntegerFormFieldSettings":
679
+ return await this.createIntegerFormFieldRequestItem(result.title);
680
+ case "RatingFormFieldSettings":
681
+ return await this.createRatingFormFieldRequestItem(result.title);
682
+ case "SelectionFormFieldSettings":
683
+ return await this.createSelectionFormFieldRequestItem(result.title);
684
+ case "StringFormFieldSettings":
685
+ return await this.createStringFormFieldRequestItem(result.title);
686
+ default:
687
+ return console.log("Invalid form field settings");
688
+ }
689
+ }
690
+ createBooleanFormFieldRequestItem(title) {
691
+ const requestItem = {
692
+ "@type": "FormFieldRequestItem",
693
+ mustBeAccepted: true,
694
+ title,
695
+ settings: {
696
+ "@type": "BooleanFormFieldSettings",
697
+ },
698
+ };
699
+ return requestItem;
700
+ }
701
+ createDateFormFieldRequestItem(title) {
702
+ const requestItem = {
703
+ "@type": "FormFieldRequestItem",
704
+ mustBeAccepted: true,
705
+ title,
706
+ settings: {
707
+ "@type": "DateFormFieldSettings",
708
+ },
709
+ };
710
+ return requestItem;
711
+ }
712
+ async createDoubleFormFieldRequestItem(title) {
713
+ const maxNumberOfDecimalDigits = 16;
714
+ const result = await prompts([
715
+ {
716
+ message: "[Optional] Enter the name of the unit of the requested double",
717
+ type: "text",
718
+ name: "unit",
719
+ format: (value) => (value.length > 0 ? value : undefined),
720
+ },
721
+ {
722
+ message: "[Optional] Enter a number as lower limit for the requested double",
723
+ type: "number",
724
+ float: true,
725
+ round: maxNumberOfDecimalDigits,
726
+ name: "min",
727
+ format: (value) => (typeof value === "number" ? value : undefined),
728
+ },
729
+ {
730
+ message: "[Optional] Enter a number as upper limit for the requested double",
731
+ type: "number",
732
+ float: true,
733
+ round: maxNumberOfDecimalDigits,
734
+ name: "max",
735
+ format: (value) => (typeof value === "number" ? value : undefined),
736
+ },
737
+ ]);
738
+ const requestItem = {
739
+ "@type": "FormFieldRequestItem",
740
+ mustBeAccepted: true,
741
+ title,
742
+ settings: {
743
+ "@type": "DoubleFormFieldSettings",
744
+ unit: result.unit,
745
+ min: result.min,
746
+ max: result.max,
747
+ },
748
+ };
749
+ return requestItem;
750
+ }
751
+ async createIntegerFormFieldRequestItem(title) {
752
+ const result = await prompts([
753
+ {
754
+ message: "[Optional] Enter the name of the unit of the requested integer",
755
+ type: "text",
756
+ name: "unit",
757
+ format: (value) => (value.length > 0 ? value : undefined),
758
+ },
759
+ {
760
+ message: "[Optional] Enter an integer as lower limit for the requested integer",
761
+ type: "number",
762
+ name: "min",
763
+ format: (value) => (typeof value === "number" ? value : undefined),
764
+ validate: (value) => (Number.isInteger(value) ? true : "The min must be an integer"),
765
+ },
766
+ {
767
+ message: "[Optional] Enter an integer as upper limit for the requested integer",
768
+ type: "number",
769
+ name: "max",
770
+ format: (value) => (typeof value === "number" ? value : undefined),
771
+ validate: (value) => (Number.isInteger(value) ? true : "The max must be an integer"),
772
+ },
773
+ ]);
774
+ const requestItem = {
775
+ "@type": "FormFieldRequestItem",
776
+ mustBeAccepted: true,
777
+ title,
778
+ settings: {
779
+ "@type": "IntegerFormFieldSettings",
780
+ unit: result.unit,
781
+ min: result.min,
782
+ max: result.max,
783
+ },
784
+ };
785
+ return requestItem;
786
+ }
787
+ async createRatingFormFieldRequestItem(title) {
788
+ const result = await prompts({
789
+ message: "Enter an integer from five to ten as upper limit for the requested rating",
790
+ type: "number",
791
+ name: "maxRating",
792
+ validate: (value) => (Number.isInteger(value) && value >= 5 && value <= 10 ? true : "The maxRating must be an integer from five to ten"),
793
+ });
794
+ const requestItem = {
795
+ "@type": "FormFieldRequestItem",
796
+ mustBeAccepted: true,
797
+ title,
798
+ settings: {
799
+ "@type": "RatingFormFieldSettings",
800
+ maxRating: result.maxRating,
801
+ },
802
+ };
803
+ return requestItem;
804
+ }
805
+ async createSelectionFormFieldRequestItem(title) {
806
+ const result = await prompts([
807
+ {
808
+ message: "Which options can be selected? (comma-separated)",
809
+ type: "list",
810
+ separator: ",",
811
+ name: "options",
812
+ format: (value) => value.filter((option) => option.length > 0),
813
+ validate: (value) => value
814
+ .split(",")
815
+ .map((option) => option.trim())
816
+ .filter((option) => option.length > 0).length > 0
817
+ ? true
818
+ : "At least one option must be provided",
819
+ },
820
+ {
821
+ message: "[Optional] Should multiple selection be allowed?",
822
+ type: "confirm",
823
+ name: "allowMultipleSelection",
824
+ initial: false,
825
+ },
826
+ ]);
827
+ const allowMultipleSelection = result.allowMultipleSelection ? true : undefined;
828
+ const requestItem = {
829
+ "@type": "FormFieldRequestItem",
830
+ mustBeAccepted: true,
831
+ title,
832
+ settings: {
833
+ "@type": "SelectionFormFieldSettings",
834
+ options: result.options,
835
+ allowMultipleSelection,
836
+ },
837
+ };
838
+ return requestItem;
839
+ }
840
+ async createStringFormFieldRequestItem(title) {
841
+ const result = await prompts([
842
+ {
843
+ message: "[Optional] Should newlines be allowed?",
844
+ type: "confirm",
845
+ name: "allowNewlines",
846
+ initial: false,
847
+ },
848
+ {
849
+ message: "[Optional] Enter a non-negative integer as lower limit for the length of the requested string",
850
+ type: "number",
851
+ name: "min",
852
+ format: (value) => (typeof value === "number" ? value : undefined),
853
+ validate: (value) => (Number.isInteger(value) && value > 0 ? true : "The min must be a non-negative integer"),
854
+ },
855
+ {
856
+ message: "[Optional] Enter a non-negative integer as upper limit for the length of the requested string",
857
+ type: "number",
858
+ name: "max",
859
+ format: (value) => (typeof value === "number" ? value : undefined),
860
+ validate: (value) => (Number.isInteger(value) && value > 0 ? true : "The max must be a non-negative integer"),
861
+ },
862
+ ]);
863
+ const allowNewlines = result.allowNewlines ? true : undefined;
864
+ const requestItem = {
865
+ "@type": "FormFieldRequestItem",
866
+ mustBeAccepted: true,
867
+ title,
868
+ settings: {
869
+ "@type": "StringFormFieldSettings",
870
+ allowNewlines,
871
+ min: result.min,
872
+ max: result.max,
873
+ },
874
+ };
875
+ return requestItem;
876
+ }
618
877
  async createFreeTextRequestItem() {
619
878
  const result = await prompts([
620
879
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nmshd/connector-tui",
3
- "version": "2.7.0",
3
+ "version": "2.9.0",
4
4
  "repository": "github:nmshd/connector-tui",
5
5
  "license": "MIT",
6
6
  "author": "j&s-soft AG",