@reqquest/ui 1.1.17 → 1.1.18

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.
@@ -375,6 +375,12 @@ type AppRequestActions {
375
375
  """
376
376
  completeReview: Boolean!
377
377
 
378
+ """User is able to create a new internal note on the app request."""
379
+ createNote: Boolean!
380
+
381
+ """User is able to create a new internal note on the app request."""
382
+ createPersistentNote: Boolean!
383
+
378
384
  """
379
385
  User may reopen this app request, whether as the owner or as a reviewer/admin.
380
386
  """
@@ -874,7 +880,7 @@ type ApplicationRequirement {
874
880
  A human readable title for the requirement in the navigation. You probably want it to be shorter than the full title. If not provided, the title will be used.
875
881
  """
876
882
  navTitle: String!
877
- prompts: [RequirementPrompt!]!
883
+ prompts(filter: RequirementPromptFilter): [RequirementPrompt!]!
878
884
 
879
885
  """
880
886
  The smart title for this requirement in the app request's period. For instance, might be "Applicant must have GPA over 3.4" instead of the regular title "Applicant must meet GPA requirement". Will fall back to the regular title for any requirement that does not provide a smart title.
@@ -1086,7 +1092,9 @@ type Mutation {
1086
1092
  addNote(
1087
1093
  """The content of the note. HTML is expected."""
1088
1094
  content: String!
1089
- ): ValidatedAppRequestResponse!
1095
+ persistent: Boolean
1096
+ validateOnly: Boolean
1097
+ ): ValidatedNoteResponse!
1090
1098
 
1091
1099
  """
1092
1100
  Moves the application to the next workflow stage. If phase is READY_FOR_WORKFLOW, moves to the first or next blocking workflow stage. If on the last blocking workflow, moves to REVIEW_COMPLETE. If on the last non-blocking workflow, moves the application to COMPLETE. If all applications are COMPLETE, automatically triggers the app request close mutation.
@@ -1125,7 +1133,7 @@ type Mutation {
1125
1133
  createPeriod(copyPeriodId: String, period: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
1126
1134
 
1127
1135
  """Delete an existing note."""
1128
- deleteNote(noteId: String!): Boolean!
1136
+ deleteNote(noteId: ID!): Boolean!
1129
1137
  deletePeriod(periodId: ID!): ValidatedResponse!
1130
1138
  markPeriodReviewed(periodId: ID!, validateOnly: Boolean): ValidatedPeriodResponse!
1131
1139
 
@@ -1163,12 +1171,24 @@ type Mutation {
1163
1171
  roleUpdate(role: AccessRoleInput!, roleId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
1164
1172
  roleUpdateGrant(grant: AccessRoleGrantUpdate!, grantId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
1165
1173
 
1174
+ """Stage the data for a prompt in this app request."""
1175
+ stagePrompt(
1176
+ """
1177
+ The data version of the app request at the time this prompt was loaded. If provided, the API will perform an optimistic concurrency check and fail the update if someone else has updated the data in the meantime.
1178
+ """
1179
+ dataVersion: Int
1180
+ promptId: ID!
1181
+ ): ValidatedAppRequestResponse!
1182
+
1166
1183
  """Submit the app request."""
1167
1184
  submitAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
1185
+
1186
+ """Toggle an existing note's persistent status."""
1187
+ togglePersistence(noteId: ID!): ValidatedNoteResponse!
1168
1188
  updateConfiguration(data: JsonData!, key: String!, periodId: ID!, validateOnly: Boolean): ValidatedConfigurationResponse!
1169
1189
 
1170
1190
  """Update the content of an existing note."""
1171
- updateNote(content: String!, noteId: String!): Note!
1191
+ updateNote(content: String!, noteId: ID!): ValidatedNoteResponse!
1172
1192
  updatePeriod(periodId: ID!, update: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
1173
1193
  updatePeriodRequirement(disabled: Boolean!, periodId: String!, requirementKey: String!): ValidatedResponse!
1174
1194
 
@@ -1231,6 +1251,11 @@ type Note {
1231
1251
  content: String!
1232
1252
  createdAt: DateTime!
1233
1253
  id: ID!
1254
+
1255
+ """
1256
+ Whether this note contains permanently useful information about a person, as opposed to only being relevant in the context of the app request it was posted to.
1257
+ """
1258
+ persistent: Boolean!
1234
1259
  updatedAt: DateTime!
1235
1260
  }
1236
1261
 
@@ -1238,6 +1263,7 @@ type Note {
1238
1263
  type NoteActions {
1239
1264
  delete: Boolean!
1240
1265
  update: Boolean!
1266
+ updatePersistent: Boolean!
1241
1267
  }
1242
1268
 
1243
1269
  input Pagination {
@@ -1625,6 +1651,9 @@ type RequirementPrompt {
1625
1651
  schemaVersion: String
1626
1652
  ): JsonData
1627
1653
 
1654
+ """Smartly identifies if the prompt requires pre staging processing."""
1655
+ prestage: Boolean!
1656
+
1628
1657
  """The requirement that this prompt is associated with."""
1629
1658
  requirement: ApplicationRequirement!
1630
1659
 
@@ -1643,6 +1672,19 @@ type RequirementPromptActions {
1643
1672
  update: Boolean!
1644
1673
  }
1645
1674
 
1675
+ input RequirementPromptFilter {
1676
+ """When true only returns answered prompts."""
1677
+ answered: Boolean
1678
+ appRequestIds: [ID!]
1679
+ applicationIds: [ID!]
1680
+ ids: [ID!]
1681
+ promptKeys: [String!]
1682
+
1683
+ """When true only returns reachable prompts."""
1684
+ reachable: Boolean
1685
+ requirementIds: [ID!]
1686
+ }
1687
+
1646
1688
  enum RequirementStatus {
1647
1689
  """
1648
1690
  The requirement has not been met, and it means the application is denied/ineligible.
@@ -1730,6 +1772,16 @@ type ValidatedConfigurationResponse {
1730
1772
  success: Boolean!
1731
1773
  }
1732
1774
 
1775
+ type ValidatedNoteResponse {
1776
+ messages: [MutationMessage!]!
1777
+ note: Note!
1778
+
1779
+ """
1780
+ True if the mutation succeeded (e.g. saved data or passed validation), even if there were warnings.
1781
+ """
1782
+ success: Boolean!
1783
+ }
1784
+
1733
1785
  type ValidatedPeriodResponse {
1734
1786
  messages: [MutationMessage!]!
1735
1787
  period: Period
@@ -284,6 +284,12 @@ export const isValidatedConfigurationResponse = (obj) => {
284
284
  throw new Error('__typename is missing in "isValidatedConfigurationResponse"');
285
285
  return ValidatedConfigurationResponse_possibleTypes.includes(obj.__typename);
286
286
  };
287
+ const ValidatedNoteResponse_possibleTypes = ['ValidatedNoteResponse'];
288
+ export const isValidatedNoteResponse = (obj) => {
289
+ if (!obj?.__typename)
290
+ throw new Error('__typename is missing in "isValidatedNoteResponse"');
291
+ return ValidatedNoteResponse_possibleTypes.includes(obj.__typename);
292
+ };
287
293
  const ValidatedPeriodResponse_possibleTypes = ['ValidatedPeriodResponse'];
288
294
  export const isValidatedPeriodResponse = (obj) => {
289
295
  if (!obj?.__typename)
@@ -195,6 +195,8 @@ declare const _default: {
195
195
  close: number[];
196
196
  completeRequest: number[];
197
197
  completeReview: number[];
198
+ createNote: number[];
199
+ createPersistentNote: number[];
198
200
  reopen: number[];
199
201
  returnToApplicant: number[];
200
202
  returnToNonBlocking: number[];
@@ -305,7 +307,9 @@ declare const _default: {
305
307
  id: number[];
306
308
  key: number[];
307
309
  navTitle: number[];
308
- prompts: number[];
310
+ prompts: (number | {
311
+ filter: number[];
312
+ })[];
309
313
  smartTitle: number[];
310
314
  status: number[];
311
315
  statusReason: number[];
@@ -379,6 +383,8 @@ declare const _default: {
379
383
  })[];
380
384
  addNote: (number | {
381
385
  content: (string | number)[];
386
+ persistent: number[];
387
+ validateOnly: number[];
382
388
  })[];
383
389
  advanceWorkflow: (number | {
384
390
  applicationId: (string | number)[];
@@ -460,9 +466,16 @@ declare const _default: {
460
466
  grantId: (string | number)[];
461
467
  validateOnly: number[];
462
468
  })[];
469
+ stagePrompt: (number | {
470
+ dataVersion: number[];
471
+ promptId: (string | number)[];
472
+ })[];
463
473
  submitAppRequest: (number | {
464
474
  appRequestId: (string | number)[];
465
475
  })[];
476
+ togglePersistence: (number | {
477
+ noteId: (string | number)[];
478
+ })[];
466
479
  updateConfiguration: (number | {
467
480
  data: (string | number)[];
468
481
  key: (string | number)[];
@@ -505,12 +518,14 @@ declare const _default: {
505
518
  content: number[];
506
519
  createdAt: number[];
507
520
  id: number[];
521
+ persistent: number[];
508
522
  updatedAt: number[];
509
523
  __typename: number[];
510
524
  };
511
525
  NoteActions: {
512
526
  delete: number[];
513
527
  update: number[];
528
+ updatePersistent: number[];
514
529
  __typename: number[];
515
530
  };
516
531
  Pagination: {
@@ -687,6 +702,7 @@ declare const _default: {
687
702
  preloadData: (number | {
688
703
  schemaVersion: number[];
689
704
  })[];
705
+ prestage: number[];
690
706
  requirement: number[];
691
707
  title: number[];
692
708
  visibility: number[];
@@ -696,6 +712,16 @@ declare const _default: {
696
712
  update: number[];
697
713
  __typename: number[];
698
714
  };
715
+ RequirementPromptFilter: {
716
+ answered: number[];
717
+ appRequestIds: number[];
718
+ applicationIds: number[];
719
+ ids: number[];
720
+ promptKeys: number[];
721
+ reachable: number[];
722
+ requirementIds: number[];
723
+ __typename: number[];
724
+ };
699
725
  RequirementStatus: {};
700
726
  RequirementType: {};
701
727
  RoleActions: {
@@ -716,6 +742,12 @@ declare const _default: {
716
742
  success: number[];
717
743
  __typename: number[];
718
744
  };
745
+ ValidatedNoteResponse: {
746
+ messages: number[];
747
+ note: number[];
748
+ success: number[];
749
+ __typename: number[];
750
+ };
719
751
  ValidatedPeriodResponse: {
720
752
  messages: number[];
721
753
  period: number[];