@reqquest/ui 1.15.0 → 1.16.0

package/dist/registry.d.ts

@@ -314,6 +314,12 @@ export interface UIConfig<PK extends string = PromptKey, RK extends string = Req
         title?: string;
         subTitle?: string;
     };
+    /**
+     * Shown to the applicant on the program review and submission review screens when there is no program
+     * left to list: none they are eligible for, and every ineligible one belongs to a program that sets
+     * `showIneligiblePreSubmit: false`. Defaults to a generic "you don't currently qualify" message.
+     */
+    applicantNoProgramsMessage?: string;
     /**
      * Whether to constrain the applicant review/submission page to a medium
      * screen-width container. Defaults to true.

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

@@ -55,6 +55,8 @@ export interface AccessControlGroup {
 export interface AccessGrantTag {
     category: Scalars['String'];
     categoryLabel: Scalars['String'];
+    /** Extra context for the tag, such as the other titles a program has gone by in different periods. */
+    description: (Scalars['String'] | null);
     label: Scalars['String'];
     tag: Scalars['String'];
     __typename: 'AccessGrantTag';
@@ -123,6 +125,8 @@ export interface AccessRoleValidatedResponse {
     __typename: 'AccessRoleValidatedResponse';
 }
 export interface AccessTag {
+    /** Extra context for the tag, such as the other titles a program has gone by in different periods. */
+    description: (Scalars['String'] | null);
     label: Scalars['String'];
     value: Scalars['String'];
     __typename: 'AccessTag';
@@ -269,6 +273,14 @@ export interface AppRequestActivity {
     user: AccessUser;
     __typename: 'AppRequestActivity';
 }
+/** Applicant counts for a set of appRequests. A request is a returning application when its applicant also submitted a request in an earlier period (by open date); otherwise it is a first-time application. Unsubmitted drafts in earlier periods do not count. */
+export interface AppRequestApplicantCounts {
+    /** Matching appRequests whose applicant submitted nothing in any earlier period. */
+    firstTime: Scalars['Int'];
+    /** Matching appRequests whose applicant also submitted a request in an earlier period. */
+    returning: Scalars['Int'];
+    __typename: 'AppRequestApplicantCounts';
+}
 /** This represents an index category attached to an app request. Its tagStrings property contains the tag values that have been extracted from the app request data. */
 export interface AppRequestIndexCategory {
     /** If this is > 0, the index values should be shown on the main app request list page, sorted by this priority in descending order. */
@@ -308,6 +320,8 @@ export interface Application {
     awaitingCorrection: Scalars['Boolean'];
     /** A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context. */
     eligibilityDescription: (Scalars['String'] | null);
+    /** True when the program sets showIneligiblePreSubmit: false and this application is hidden by it: ineligible because of an applicant requirement, and that ineligibility arose before submission (the request is unsubmitted, or the application was already ineligible when it was submitted). Only the applicant ever receives a hidden application, so they can still change the answers that disqualified them; UIs should leave it out of program lists. */
+    hiddenIneligiblePreSubmit: Scalars['Boolean'];
     id: Scalars['ID'];
     /** The phase in which this application became ineligible for benefits. Useful for reporting / filtering. Null if the application is not (yet) ineligible. */
     ineligiblePhase: (IneligiblePhases | null);
@@ -462,7 +476,7 @@ export interface Configuration {
     actions: ConfigurationAccess;
     data: Scalars['JsonData'];
     fetchedData: (Scalars['JsonData'] | null);
-    /** The key being configured. Could be a requirement or prompt key. */
+    /** The key being configured. Could be a requirement, prompt, or program key. A program's configuration holds its per-period title and navTitle overrides. */
     key: Scalars['String'];
     __typename: 'Configuration';
 }
@@ -642,6 +656,8 @@ export interface PeriodProgram {
     actions: PeriodProgramActions;
     /** A brief description of the program, written for applicants. */
     applicantDescription: (Scalars['String'] | null);
+    /** The configuration for this program in the period, which holds its title and navTitle overrides. */
+    configuration: Configuration;
     /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
     eligibilityDescription: (Scalars['String'] | null);
     /** Whether the program is enabled in this period. This is set by the system administrator. */
@@ -728,6 +744,8 @@ export interface Query {
     applicationMetrics: ApplicationMetric;
     /** This is where you get information about the authorization system. Each grant will be associated with one of these controlGroups, one or more controls in the group, and an optional set of tags. The tags are used to limit the scope of the grant. */
     controlGroups: AccessControlGroup[];
+    /** First-time vs returning applicant counts for the matching appRequests (see AppRequestApplicantCounts). */
+    countAppRequestApplicants: AppRequestApplicantCounts;
     countAppRequests: Scalars['Int'];
     pageInfo: PaginationResponse;
     periods: Period[];
@@ -887,6 +905,8 @@ export interface AccessControlGroupGenqlSelection {
 export interface AccessGrantTagGenqlSelection {
     category?: boolean | number;
     categoryLabel?: boolean | number;
+    /** Extra context for the tag, such as the other titles a program has gone by in different periods. */
+    description?: boolean | number;
     label?: boolean | number;
     tag?: boolean | number;
     __typename?: boolean | number;
@@ -993,6 +1013,8 @@ export interface AccessRoleValidatedResponseGenqlSelection {
     __scalar?: boolean | number;
 }
 export interface AccessTagGenqlSelection {
+    /** Extra context for the tag, such as the other titles a program has gone by in different periods. */
+    description?: boolean | number;
     label?: boolean | number;
     value?: boolean | number;
     __typename?: boolean | number;
@@ -1244,7 +1266,18 @@ export interface AppRequestActivityFilters {
     /** Return activities that were performed by one of the given logins. Also returns activities that were performed while one of the given logins was impersonating someone else. */
     users?: (Scalars['ID'][] | null);
 }
+/** Applicant counts for a set of appRequests. A request is a returning application when its applicant also submitted a request in an earlier period (by open date); otherwise it is a first-time application. Unsubmitted drafts in earlier periods do not count. */
+export interface AppRequestApplicantCountsGenqlSelection {
+    /** Matching appRequests whose applicant submitted nothing in any earlier period. */
+    firstTime?: boolean | number;
+    /** Matching appRequests whose applicant also submitted a request in an earlier period. */
+    returning?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
 export interface AppRequestFilter {
+    /** Only return appRequests with at least one application matching one of the given entries (OR). When programKeys is also given, the same application must match both. */
+    applicationStatuses?: (ApplicationStatusFilter[] | null);
     /** true -> only return appRequests that are closed. false -> only return appRequests that are open. null -> return all appRequests. */
     closed?: (Scalars['Boolean'] | null);
     /** Only return appRequests that were closed after this date. Open appRequests will be filtered out. */
@@ -1265,6 +1298,8 @@ export interface AppRequestFilter {
     /** Only return appRequests that are owned by the current user. */
     own?: (Scalars['Boolean'] | null);
     periodIds?: (Scalars['ID'][] | null);
+    /** Only return appRequests that have an application for one of the given programs. When applicationStatuses is also given, the same application must match both. */
+    programKeys?: (Scalars['ID'][] | null);
     /** Only return appRequests where at least one application is in one of the given rescinded states. Rescinding is per-application, so this is independent of the appRequest status. */
     rescindedStatus?: (ApplicationRescindedStatus[] | null);
     /** Only return appRequests that have had their review started. true -> return review started, false -> return not started. Note that this is NOT mutually exclusive with complete or closed, it very simply means that a non-applicant has taken an action on it. */
@@ -1322,6 +1357,8 @@ export interface ApplicationGenqlSelection {
     awaitingCorrection?: boolean | number;
     /** A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context. */
     eligibilityDescription?: boolean | number;
+    /** True when the program sets showIneligiblePreSubmit: false and this application is hidden by it: ineligible because of an applicant requirement, and that ineligibility arose before submission (the request is unsubmitted, or the application was already ineligible when it was submitted). Only the applicant ever receives a hidden application, so they can still change the answers that disqualified them; UIs should leave it out of program lists. */
+    hiddenIneligiblePreSubmit?: boolean | number;
     id?: boolean | number;
     /** The phase in which this application became ineligible for benefits. Useful for reporting / filtering. Null if the application is not (yet) ineligible. */
     ineligiblePhase?: boolean | number;
@@ -1440,6 +1477,12 @@ export interface ApplicationRequirementGenqlSelection {
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
+/** Matches an application by its stored status and, optionally, its rescind state. Status is the stored computedStatus, so RESCINDED is not a valid value here - express it as status ELIGIBLE or ACCEPTED with rescindedStatus RESCINDED. */
+export interface ApplicationStatusFilter {
+    /** When omitted, matches applications currently in the given status (not rescinded). When given, matches only applications in exactly that rescind state. */
+    rescindedStatus?: (ApplicationRescindedStatus | null);
+    status: ApplicationStatus;
+}
 export interface CategoryGenqlSelection {
     /** This is indexed name of the category. Categories are indexed to allow for quick filtering of a list of items. e.g. institutionalRoles */
     category?: boolean | number;
@@ -1466,7 +1509,7 @@ export interface ConfigurationGenqlSelection {
     actions?: ConfigurationAccessGenqlSelection;
     data?: boolean | number;
     fetchedData?: boolean | number;
-    /** The key being configured. Could be a requirement or prompt key. */
+    /** The key being configured. Could be a requirement, prompt, or program key. A program's configuration holds its per-period title and navTitle overrides. */
     key?: boolean | number;
     __typename?: boolean | number;
     __scalar?: boolean | number;
@@ -1922,6 +1965,8 @@ export interface PeriodProgramGenqlSelection {
     actions?: PeriodProgramActionsGenqlSelection;
     /** A brief description of the program, written for applicants. */
     applicantDescription?: boolean | number;
+    /** The configuration for this program in the period, which holds its title and navTitle overrides. */
+    configuration?: ConfigurationGenqlSelection;
     /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
     eligibilityDescription?: boolean | number;
     /** Whether the program is enabled in this period. This is set by the system administrator. */
@@ -2053,6 +2098,12 @@ export interface QueryGenqlSelection {
     });
     /** This is where you get information about the authorization system. Each grant will be associated with one of these controlGroups, one or more controls in the group, and an optional set of tags. The tags are used to limit the scope of the grant. */
     controlGroups?: AccessControlGroupGenqlSelection;
+    /** First-time vs returning applicant counts for the matching appRequests (see AppRequestApplicantCounts). */
+    countAppRequestApplicants?: (AppRequestApplicantCountsGenqlSelection & {
+        __args?: {
+            filter?: (AppRequestFilter | null);
+        };
+    });
     countAppRequests?: {
         __args: {
             filter?: (AppRequestFilter | null);
@@ -2275,6 +2326,9 @@ export declare const isAppRequestActions: (obj?: {
 export declare const isAppRequestActivity: (obj?: {
     __typename?: any;
 } | null) => obj is AppRequestActivity;
+export declare const isAppRequestApplicantCounts: (obj?: {
+    __typename?: any;
+} | null) => obj is AppRequestApplicantCounts;
 export declare const isAppRequestIndexCategory: (obj?: {
     __typename?: any;
 } | null) => obj is AppRequestIndexCategory;

package/dist/typed-client/schema.graphql

@@ -78,6 +78,11 @@ type AccessControlGroup {
 type AccessGrantTag {
   category: String!
   categoryLabel: String!
+
+  """
+  Extra context for the tag, such as the other titles a program has gone by in different periods.
+  """
+  description: String
   label: String!
   tag: String!
 }
@@ -195,6 +200,10 @@ type AccessRoleValidatedResponse {
 }
 
 type AccessTag {
+  """
+  Extra context for the tag, such as the other titles a program has gone by in different periods.
+  """
+  description: String
   label: String!
   value: String!
 }
@@ -591,7 +600,27 @@ input AppRequestActivityFilters {
   users: [ID!]
 }
 
+"""
+Applicant counts for a set of appRequests. A request is a returning application when its applicant also submitted a request in an earlier period (by open date); otherwise it is a first-time application. Unsubmitted drafts in earlier periods do not count.
+"""
+type AppRequestApplicantCounts {
+  """
+  Matching appRequests whose applicant submitted nothing in any earlier period.
+  """
+  firstTime: Int!
+
+  """
+  Matching appRequests whose applicant also submitted a request in an earlier period.
+  """
+  returning: Int!
+}
+
 input AppRequestFilter {
+  """
+  Only return appRequests with at least one application matching one of the given entries (OR). When programKeys is also given, the same application must match both.
+  """
+  applicationStatuses: [ApplicationStatusFilter!]
+
   """
   true -> only return appRequests that are closed. false -> only return appRequests that are open. null -> return all appRequests.
   """
@@ -629,6 +658,11 @@ input AppRequestFilter {
   own: Boolean
   periodIds: [ID!]
 
+  """
+  Only return appRequests that have an application for one of the given programs. When applicationStatuses is also given, the same application must match both.
+  """
+  programKeys: [ID!]
+
   """
   Only return appRequests where at least one application is in one of the given rescinded states. Rescinding is per-application, so this is independent of the appRequest status.
   """
@@ -864,6 +898,11 @@ type Application {
   A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context.
   """
   eligibilityDescription: String
+
+  """
+  True when the program sets showIneligiblePreSubmit: false and this application is hidden by it: ineligible because of an applicant requirement, and that ineligibility arose before submission (the request is unsubmitted, or the application was already ineligible when it was submitted). Only the applicant ever receives a hidden application, so they can still change the answers that disqualified them; UIs should leave it out of program lists.
+  """
+  hiddenIneligiblePreSubmit: Boolean!
   id: ID!
 
   """
@@ -1128,7 +1167,7 @@ enum ApplicationStatus {
   ACCEPTED
 
   """
-  All application requirements up to and including WORKFLOW_BLOCKING requirements are resolving as MET (or NOT_APPLICABLE or WARNING). If there is an acceptance phase, the acceptance is still pending.
+  Every requirement the current phase evaluates is resolving as MET (or NOT_APPLICABLE or WARNING). Before submission that is only the applicant requirements (PREQUAL, QUALIFICATION, POSTQUAL), so ELIGIBLE means nothing so far disqualifies - not that the program has been approved. After submission it covers all requirements up to and including WORKFLOW_BLOCKING. If there is an acceptance phase, the acceptance is still pending.
   """
   ELIGIBLE
 
@@ -1153,6 +1192,17 @@ enum ApplicationStatus {
   RESCINDED
 }
 
+"""
+Matches an application by its stored status and, optionally, its rescind state. Status is the stored computedStatus, so RESCINDED is not a valid value here - express it as status ELIGIBLE or ACCEPTED with rescindedStatus RESCINDED.
+"""
+input ApplicationStatusFilter {
+  """
+  When omitted, matches applications currently in the given status (not rescinded). When given, matches only applications in exactly that rescind state.
+  """
+  rescindedStatus: ApplicationRescindedStatus
+  status: ApplicationStatus!
+}
+
 type Category {
   """
   This is indexed name of the category. Categories are indexed to allow for quick filtering of a list of items. e.g. institutionalRoles
@@ -1195,7 +1245,9 @@ type Configuration {
   data: JsonData!
   fetchedData: JsonData
 
-  """The key being configured. Could be a requirement or prompt key."""
+  """
+  The key being configured. Could be a requirement, prompt, or program key. A program's configuration holds its per-period title and navTitle overrides.
+  """
   key: String!
 }
 
@@ -1274,22 +1326,26 @@ type IndexValue {
 }
 
 enum IneligiblePhases {
-  """The application became ineligible in the acceptance phase."""
+  """The application was disqualified by an ACCEPTANCE requirement."""
   ACCEPTANCE
 
-  """The application became ineligible in the approval phase."""
+  """The application was disqualified by an APPROVAL requirement."""
   APPROVAL
 
-  """The application became ineligible in the pre-approval phase."""
+  """The application was disqualified by a PREAPPROVAL requirement."""
   PREAPPROVAL
 
-  """The application became ineligible in the pre-qualification phase."""
+  """
+  The application was disqualified by a PREQUAL requirement. Names the type of requirement that failed, not when it failed - a reviewer changing an applicant answer after submission can also produce this.
+  """
   PREQUAL
 
-  """The application became ineligible in the qualification phase."""
+  """
+  The application was disqualified by a QUALIFICATION or POSTQUAL requirement. Names the type of requirement that failed, not when it failed - a reviewer changing an applicant answer after submission can also produce this.
+  """
   QUALIFICATION
 
-  """The application became ineligible during blocking workflow."""
+  """The application was disqualified by a blocking workflow requirement."""
   WORKFLOW
 }
 
@@ -1684,6 +1740,11 @@ type PeriodProgram {
   """A brief description of the program, written for applicants."""
   applicantDescription: String
 
+  """
+  The configuration for this program in the period, which holds its title and navTitle overrides.
+  """
+  configuration: Configuration!
+
   """
   A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts.
   """
@@ -1867,6 +1928,11 @@ type Query {
   This is where you get information about the authorization system. Each grant will be associated with one of these controlGroups, one or more controls in the group, and an optional set of tags. The tags are used to limit the scope of the grant.
   """
   controlGroups: [AccessControlGroup!]!
+
+  """
+  First-time vs returning applicant counts for the matching appRequests (see AppRequestApplicantCounts).
+  """
+  countAppRequestApplicants(filter: AppRequestFilter): AppRequestApplicantCounts!
   countAppRequests(filter: AppRequestFilter): Int!
   pageInfo: PaginationResponse!
   periods(filter: PeriodFilters): [Period!]!

package/dist/typed-client/schema.js

@@ -110,6 +110,12 @@ export const isAppRequestActivity = (obj) => {
         throw new Error('__typename is missing in "isAppRequestActivity"');
     return AppRequestActivity_possibleTypes.includes(obj.__typename);
 };
+const AppRequestApplicantCounts_possibleTypes = ['AppRequestApplicantCounts'];
+export const isAppRequestApplicantCounts = (obj) => {
+    if (!obj?.__typename)
+        throw new Error('__typename is missing in "isAppRequestApplicantCounts"');
+    return AppRequestApplicantCounts_possibleTypes.includes(obj.__typename);
+};
 const AppRequestIndexCategory_possibleTypes = ['AppRequestIndexCategory'];
 export const isAppRequestIndexCategory = (obj) => {
     if (!obj?.__typename)

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

@@ -33,6 +33,7 @@ declare const _default: {
         AccessGrantTag: {
             category: number[];
             categoryLabel: number[];
+            description: number[];
             label: number[];
             tag: number[];
             __typename: number[];
@@ -109,6 +110,7 @@ declare const _default: {
             __typename: number[];
         };
         AccessTag: {
+            description: number[];
             label: number[];
             value: number[];
             __typename: number[];
@@ -266,7 +268,13 @@ declare const _default: {
             users: number[];
             __typename: number[];
         };
+        AppRequestApplicantCounts: {
+            firstTime: number[];
+            returning: number[];
+            __typename: number[];
+        };
         AppRequestFilter: {
+            applicationStatuses: number[];
             closed: number[];
             closedAfter: number[];
             closedBefore: number[];
@@ -278,6 +286,7 @@ declare const _default: {
             logins: number[];
             own: number[];
             periodIds: number[];
+            programKeys: number[];
             rescindedStatus: number[];
             reviewStarted: number[];
             search: number[];
@@ -318,6 +327,7 @@ declare const _default: {
             applicantDescription: number[];
             awaitingCorrection: number[];
             eligibilityDescription: number[];
+            hiddenIneligiblePreSubmit: number[];
             id: number[];
             ineligiblePhase: number[];
             navTitle: number[];
@@ -403,6 +413,11 @@ declare const _default: {
         };
         ApplicationRescindedStatus: {};
         ApplicationStatus: {};
+        ApplicationStatusFilter: {
+            rescindedStatus: number[];
+            status: number[];
+            __typename: number[];
+        };
         Boolean: {};
         Category: {
             category: number[];
@@ -714,6 +729,7 @@ declare const _default: {
         PeriodProgram: {
             actions: number[];
             applicantDescription: number[];
+            configuration: number[];
             eligibilityDescription: number[];
             enabled: number[];
             key: number[];
@@ -800,6 +816,9 @@ declare const _default: {
                 filter: number[];
             })[];
             controlGroups: number[];
+            countAppRequestApplicants: (number | {
+                filter: number[];
+            })[];
             countAppRequests: (number | {
                 filter: number[];
             })[];