@reqquest/ui 1.11.0 → 1.12.1

package/dist/typed-client/schema.graphql

@@ -1,4 +1,7 @@
 type Access {
+  """Current user is permitted to create announcements."""
+  createAnnouncement: Boolean!
+
   """
   Current user may create a new app request on behalf of another user and should be shown the Create App Request button on the reviewer dashboard or main app request list.
   """
@@ -19,6 +22,12 @@ type Access {
   """
   createRole: Boolean!
 
+  """Current user is permitted to delete announcements."""
+  deleteAnnouncement: Boolean!
+
+  """Current user is permitted to update announcements."""
+  updateAnnouncement: Boolean!
+
   """The current user, if any."""
   user: AccessUser
 
@@ -276,6 +285,87 @@ input AccessUserIdentifierInput {
   label: String!
 }
 
+"""
+A site-wide announcement shown to users, optionally limited to a date range.
+"""
+type Announcement {
+  """The content of the announcement in HTML."""
+  body: String!
+
+  """
+  Whether the announcement has been turned on. A disabled announcement never displays, regardless of its date range.
+  """
+  enabled: Boolean!
+
+  """
+  The announcement will not display after this date. Null means it displays until it is disabled.
+  """
+  end: DateTime
+  id: ID!
+
+  """URL the announcement directs the user to for more information."""
+  link: String
+
+  """The text to display for the link."""
+  linkText: String
+
+  """
+  The announcement will not display before this date. Null means it displays as soon as it is enabled.
+  """
+  start: DateTime
+
+  """Short headline for the announcement."""
+  subject: String!
+
+  """The type of announcement, toggleable or date range"""
+  type: String!
+}
+
+input AnnouncementFilters {
+  """
+  Return only the announcements that should be displayed at this moment: enabled OR within their date range.
+  """
+  active: Boolean
+
+  """Return only enabled (true) or only disabled (false) announcements."""
+  enabled: Boolean
+
+  """Return the announcements with these IDs."""
+  ids: [ID!]
+}
+
+input AnnouncementUpdate {
+  """
+  The content of the announcement in HTML. Unsafe markup is stripped on save.
+  """
+  body: String
+
+  """Whether the announcement has been turned on."""
+  enabled: Boolean = false
+
+  """
+  The announcement will not display after this date. Null means it displays until it is disabled.
+  """
+  end: DateTime
+
+  """URL the announcement directs the user to for more information."""
+  link: String
+
+  """The text to display for the link. Required when a link is given."""
+  linkText: String
+
+  """
+  The announcement will not display before this date. Null means it displays as soon as it is enabled.
+  """
+  start: DateTime
+
+  """Short headline for the announcement."""
+  subject: String
+
+  """The type of announcement, toggleable or date range"""
+  type: String
+}
+
 """
 Represents a group of applications all being applied for at the same time. As part of the request, multiple applications will be created and either eliminated as ineligible or submitted for approval.
 """
@@ -955,6 +1045,11 @@ The specific instance of a requirement on a particular application. Stores the s
 type ApplicationRequirement {
   application: Application!
 
+  """
+  The prompt keys the requirement named as responsible for its current status. Used to attach status indicators to the specific answers at fault instead of every prompt the requirement consults. Null when the requirement did not name any, in which case all of its prompts are implicated.
+  """
+  blame: [String!]
+
   """
   The configuration data for this requirement in the app request's period.
   """
@@ -1314,10 +1409,16 @@ type Mutation {
   """
   completeReview(appRequestId: ID!): ValidatedAppRequestResponse!
 
+  """Create a new site-wide announcement."""
+  createAnnouncement(announcement: AnnouncementUpdate!, validateOnly: Boolean): ValidatedAnnouncementResponse!
+
   """Create a new app request."""
   createAppRequest(login: String!, periodId: ID!, validateOnly: Boolean): ValidatedAppRequestResponse!
   createPeriod(copyPeriodId: String, period: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
 
+  """Delete an existing site-wide announcement."""
+  deleteAnnouncement(announcementId: ID!): ValidatedResponse!
+
   """Delete an existing note."""
   deleteNote(noteId: ID!): Boolean!
   deletePeriod(periodId: ID!): ValidatedResponse!
@@ -1368,6 +1469,9 @@ type Mutation {
 
   """Toggle an existing note's persistent status."""
   togglePersistence(noteId: ID!): ValidatedNoteResponse!
+
+  """Update an existing site-wide announcement."""
+  updateAnnouncement(announcement: AnnouncementUpdate!, announcementId: ID!, validateOnly: Boolean): ValidatedAnnouncementResponse!
   updateConfiguration(data: JsonData!, key: String!, periodId: ID!, validateOnly: Boolean): ValidatedConfigurationResponse!
 
   """Update the content of an existing note."""
@@ -1726,6 +1830,11 @@ type Query {
   access: Access!
   accessUsers(filter: AccessUserFilter, paged: Pagination): [AccessUser!]!
 
+  """
+  Retrieve site-wide announcements. Applicants only ever see currently active announcements; users with the Announcement view control see them all.
+  """
+  announcements(filter: AnnouncementFilters): [Announcement!]!
+
   """
   The activity log for this app request. This is a list of actions taken on the app request, such as submission, updating prompts, make an offer, add a note, etc. It will be sorted by the date of the activity in descending order.
   """
@@ -1845,6 +1954,11 @@ type RequirementPrompt {
   A human readable title for the prompt in the navigation. You probably want it to be shorter than the full title. If not provided, the title will be used.
   """
   navTitle: String!
+
+  """
+  True when this row exists only because its requirement listed the prompt in `promptKeysNoDisplay` - a dependency it reads but does not own. Such a row must not be rendered beneath that requirement; the prompt is displayed under the requirement that does own it. This is not derivable from `visibility`: a no-display row is UNREACHABLE, but so is a prompt whose own requirement resolved before reaching it, and that one is still the requirement's to show.
+  """
+  noDisplay: Boolean!
   optOut: Boolean!
 
   """
@@ -1965,6 +2079,19 @@ type RoleActions {
   update: Boolean!
 }
 
+type ValidatedAnnouncementResponse {
+  """
+  The created or updated announcement. Null when validateOnly was true or when validation errors prevented the operation.
+  """
+  announcement: Announcement
+  messages: [MutationMessage!]!
+
+  """
+  True if the mutation succeeded (e.g. saved data or passed validation), even if there were warnings.
+  """
+  success: Boolean!
+}
+
 type ValidatedAppRequestResponse {
   appRequest: AppRequest
   messages: [MutationMessage!]!

package/dist/typed-client/schema.js

@@ -86,6 +86,12 @@ export const isAccessUserIdentifier = (obj) => {
         throw new Error('__typename is missing in "isAccessUserIdentifier"');
     return AccessUserIdentifier_possibleTypes.includes(obj.__typename);
 };
+const Announcement_possibleTypes = ['Announcement'];
+export const isAnnouncement = (obj) => {
+    if (!obj?.__typename)
+        throw new Error('__typename is missing in "isAnnouncement"');
+    return Announcement_possibleTypes.includes(obj.__typename);
+};
 const AppRequest_possibleTypes = ['AppRequest'];
 export const isAppRequest = (obj) => {
     if (!obj?.__typename)
@@ -290,6 +296,12 @@ export const isRoleActions = (obj) => {
         throw new Error('__typename is missing in "isRoleActions"');
     return RoleActions_possibleTypes.includes(obj.__typename);
 };
+const ValidatedAnnouncementResponse_possibleTypes = ['ValidatedAnnouncementResponse'];
+export const isValidatedAnnouncementResponse = (obj) => {
+    if (!obj?.__typename)
+        throw new Error('__typename is missing in "isValidatedAnnouncementResponse"');
+    return ValidatedAnnouncementResponse_possibleTypes.includes(obj.__typename);
+};
 const ValidatedAppRequestResponse_possibleTypes = ['ValidatedAppRequestResponse'];
 export const isValidatedAppRequestResponse = (obj) => {
     if (!obj?.__typename)

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

@@ -2,10 +2,13 @@ declare const _default: {
     scalars: number[];
     types: {
         Access: {
+            createAnnouncement: number[];
             createAppRequestOther: number[];
             createAppRequestSelf: number[];
             createPeriod: number[];
             createRole: number[];
+            deleteAnnouncement: number[];
+            updateAnnouncement: number[];
             user: number[];
             viewAppRequestList: number[];
             viewApplicantDashboard: number[];
@@ -160,6 +163,35 @@ declare const _default: {
             label: number[];
             __typename: number[];
         };
+        Announcement: {
+            body: number[];
+            enabled: number[];
+            end: number[];
+            id: number[];
+            link: number[];
+            linkText: number[];
+            start: number[];
+            subject: number[];
+            type: number[];
+            __typename: number[];
+        };
+        AnnouncementFilters: {
+            active: number[];
+            enabled: number[];
+            ids: number[];
+            __typename: number[];
+        };
+        AnnouncementUpdate: {
+            body: number[];
+            enabled: number[];
+            end: number[];
+            link: number[];
+            linkText: number[];
+            start: number[];
+            subject: number[];
+            type: number[];
+            __typename: number[];
+        };
         AppRequest: {
             actions: number[];
             applicant: number[];
@@ -352,6 +384,7 @@ declare const _default: {
         ApplicationPhase: {};
         ApplicationRequirement: {
             application: number[];
+            blame: number[];
             configurationData: number[];
             description: number[];
             id: number[];
@@ -478,6 +511,10 @@ declare const _default: {
             completeReview: (number | {
                 appRequestId: (string | number)[];
             })[];
+            createAnnouncement: (number | {
+                announcement: (string | number)[];
+                validateOnly: number[];
+            })[];
             createAppRequest: (number | {
                 login: (string | number)[];
                 periodId: (string | number)[];
@@ -488,6 +525,9 @@ declare const _default: {
                 period: (string | number)[];
                 validateOnly: number[];
             })[];
+            deleteAnnouncement: (number | {
+                announcementId: (string | number)[];
+            })[];
             deleteNote: (number | {
                 noteId: (string | number)[];
             })[];
@@ -558,6 +598,11 @@ declare const _default: {
             togglePersistence: (number | {
                 noteId: (string | number)[];
             })[];
+            updateAnnouncement: (number | {
+                announcement: (string | number)[];
+                announcementId: (string | number)[];
+                validateOnly: number[];
+            })[];
             updateConfiguration: (number | {
                 data: (string | number)[];
                 key: (string | number)[];
@@ -735,6 +780,9 @@ declare const _default: {
                 filter: number[];
                 paged: number[];
             })[];
+            announcements: (number | {
+                filter: number[];
+            })[];
             appRequestActivity: (number | {
                 filters: number[];
                 id: (string | number)[];
@@ -790,6 +838,7 @@ declare const _default: {
             key: number[];
             moot: number[];
             navTitle: number[];
+            noDisplay: number[];
             optOut: number[];
             preloadData: (number | {
                 schemaVersion: number[];
@@ -824,6 +873,12 @@ declare const _default: {
             __typename: number[];
         };
         String: {};
+        ValidatedAnnouncementResponse: {
+            announcement: number[];
+            messages: number[];
+            success: number[];
+            __typename: number[];
+        };
         ValidatedAppRequestResponse: {
             appRequest: number[];
             messages: number[];