@reqquest/ui 1.1.17 → 1.2.0

package/dist/typed-client/schema.graphql

@@ -375,6 +375,12 @@ type AppRequestActions {
   """
   completeReview: Boolean!
 
+  """User is able to create a new internal note on the app request."""
+  createNote: Boolean!
+
+  """User is able to create a new internal note on the app request."""
+  createPersistentNote: Boolean!
+
   """
   User may reopen this app request, whether as the owner or as a reviewer/admin.
   """
@@ -874,7 +880,7 @@ type ApplicationRequirement {
   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.
   """
   navTitle: String!
-  prompts: [RequirementPrompt!]!
+  prompts(filter: RequirementPromptFilter): [RequirementPrompt!]!
 
   """
   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 {
   addNote(
     """The content of the note. HTML is expected."""
     content: String!
-  ): ValidatedAppRequestResponse!
+    persistent: Boolean
+    validateOnly: Boolean
+  ): ValidatedNoteResponse!
 
   """
   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 {
   createPeriod(copyPeriodId: String, period: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
 
   """Delete an existing note."""
-  deleteNote(noteId: String!): Boolean!
+  deleteNote(noteId: ID!): Boolean!
   deletePeriod(periodId: ID!): ValidatedResponse!
   markPeriodReviewed(periodId: ID!, validateOnly: Boolean): ValidatedPeriodResponse!
 
@@ -1163,12 +1171,24 @@ type Mutation {
   roleUpdate(role: AccessRoleInput!, roleId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
   roleUpdateGrant(grant: AccessRoleGrantUpdate!, grantId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
 
+  """Stage the data for a prompt in this app request."""
+  stagePrompt(
+    """
+    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.
+    """
+    dataVersion: Int
+    promptId: ID!
+  ): ValidatedAppRequestResponse!
+
   """Submit the app request."""
   submitAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """Toggle an existing note's persistent status."""
+  togglePersistence(noteId: ID!): ValidatedNoteResponse!
   updateConfiguration(data: JsonData!, key: String!, periodId: ID!, validateOnly: Boolean): ValidatedConfigurationResponse!
 
   """Update the content of an existing note."""
-  updateNote(content: String!, noteId: String!): Note!
+  updateNote(content: String!, noteId: ID!): ValidatedNoteResponse!
   updatePeriod(periodId: ID!, update: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
   updatePeriodRequirement(disabled: Boolean!, periodId: String!, requirementKey: String!): ValidatedResponse!
 
@@ -1231,6 +1251,11 @@ type Note {
   content: String!
   createdAt: DateTime!
   id: ID!
+
+  """
+  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.
+  """
+  persistent: Boolean!
   updatedAt: DateTime!
 }
 
@@ -1238,6 +1263,7 @@ type Note {
 type NoteActions {
   delete: Boolean!
   update: Boolean!
+  updatePersistent: Boolean!
 }
 
 input Pagination {
@@ -1588,6 +1614,11 @@ type RequirementPrompt {
   Extra configuration data that is relevant for this prompt. This configuration is explicitly gathered from related requirements and prompts by the gatherConfig function in the prompt definition.
   """
   gatheredConfigData: JsonData!
+
+  """
+  Identifies if the prompt already has saved data.  Assists in determining if the user has previously interacted with this prompt.
+  """
+  hasSavedData: Boolean!
   id: ID!
 
   """
@@ -1625,6 +1656,9 @@ type RequirementPrompt {
     schemaVersion: String
   ): JsonData
 
+  """Smartly identifies if the prompt requires pre staging processing."""
+  prestage: Boolean!
+
   """The requirement that this prompt is associated with."""
   requirement: ApplicationRequirement!
 
@@ -1643,6 +1677,19 @@ type RequirementPromptActions {
   update: Boolean!
 }
 
+input RequirementPromptFilter {
+  """When true only returns answered prompts."""
+  answered: Boolean
+  appRequestIds: [ID!]
+  applicationIds: [ID!]
+  ids: [ID!]
+  promptKeys: [String!]
+
+  """When true only returns reachable prompts."""
+  reachable: Boolean
+  requirementIds: [ID!]
+}
+
 enum RequirementStatus {
   """
   The requirement has not been met, and it means the application is denied/ineligible.
@@ -1730,6 +1777,16 @@ type ValidatedConfigurationResponse {
   success: Boolean!
 }
 
+type ValidatedNoteResponse {
+  messages: [MutationMessage!]!
+  note: Note!
+
+  """
+  True if the mutation succeeded (e.g. saved data or passed validation), even if there were warnings.
+  """
+  success: Boolean!
+}
+
 type ValidatedPeriodResponse {
   messages: [MutationMessage!]!
   period: Period

package/dist/typed-client/schema.js

@@ -284,6 +284,12 @@ export const isValidatedConfigurationResponse = (obj) => {
         throw new Error('__typename is missing in "isValidatedConfigurationResponse"');
     return ValidatedConfigurationResponse_possibleTypes.includes(obj.__typename);
 };
+const ValidatedNoteResponse_possibleTypes = ['ValidatedNoteResponse'];
+export const isValidatedNoteResponse = (obj) => {
+    if (!obj?.__typename)
+        throw new Error('__typename is missing in "isValidatedNoteResponse"');
+    return ValidatedNoteResponse_possibleTypes.includes(obj.__typename);
+};
 const ValidatedPeriodResponse_possibleTypes = ['ValidatedPeriodResponse'];
 export const isValidatedPeriodResponse = (obj) => {
     if (!obj?.__typename)

package/dist/typed-client/types.d.ts

@@ -195,6 +195,8 @@ declare const _default: {
             close: number[];
             completeRequest: number[];
             completeReview: number[];
+            createNote: number[];
+            createPersistentNote: number[];
             reopen: number[];
             returnToApplicant: number[];
             returnToNonBlocking: number[];
@@ -305,7 +307,9 @@ declare const _default: {
             id: number[];
             key: number[];
             navTitle: number[];
-            prompts: number[];
+            prompts: (number | {
+                filter: number[];
+            })[];
             smartTitle: number[];
             status: number[];
             statusReason: number[];
@@ -379,6 +383,8 @@ declare const _default: {
             })[];
             addNote: (number | {
                 content: (string | number)[];
+                persistent: number[];
+                validateOnly: number[];
             })[];
             advanceWorkflow: (number | {
                 applicationId: (string | number)[];
@@ -460,9 +466,16 @@ declare const _default: {
                 grantId: (string | number)[];
                 validateOnly: number[];
             })[];
+            stagePrompt: (number | {
+                dataVersion: number[];
+                promptId: (string | number)[];
+            })[];
             submitAppRequest: (number | {
                 appRequestId: (string | number)[];
             })[];
+            togglePersistence: (number | {
+                noteId: (string | number)[];
+            })[];
             updateConfiguration: (number | {
                 data: (string | number)[];
                 key: (string | number)[];
@@ -505,12 +518,14 @@ declare const _default: {
             content: number[];
             createdAt: number[];
             id: number[];
+            persistent: number[];
             updatedAt: number[];
             __typename: number[];
         };
         NoteActions: {
             delete: number[];
             update: number[];
+            updatePersistent: number[];
             __typename: number[];
         };
         Pagination: {
@@ -678,6 +693,7 @@ declare const _default: {
                 schemaVersion: number[];
             })[];
             gatheredConfigData: number[];
+            hasSavedData: number[];
             id: number[];
             invalidated: number[];
             invalidatedReason: number[];
@@ -687,6 +703,7 @@ declare const _default: {
             preloadData: (number | {
                 schemaVersion: number[];
             })[];
+            prestage: number[];
             requirement: number[];
             title: number[];
             visibility: number[];
@@ -696,6 +713,16 @@ declare const _default: {
             update: number[];
             __typename: number[];
         };
+        RequirementPromptFilter: {
+            answered: number[];
+            appRequestIds: number[];
+            applicationIds: number[];
+            ids: number[];
+            promptKeys: number[];
+            reachable: number[];
+            requirementIds: number[];
+            __typename: number[];
+        };
         RequirementStatus: {};
         RequirementType: {};
         RoleActions: {
@@ -716,6 +743,12 @@ declare const _default: {
             success: number[];
             __typename: number[];
         };
+        ValidatedNoteResponse: {
+            messages: number[];
+            note: number[];
+            success: number[];
+            __typename: number[];
+        };
         ValidatedPeriodResponse: {
             messages: number[];
             period: number[];