@reqquest/ui 1.9.1 → 1.10.0

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

@@ -275,8 +275,12 @@ export type AppRequestStatus = 'ACCEPTANCE' | 'ACCEPTED' | 'APPROVAL' | 'APPROVE
 /** An application represents the applicant applying to a specific program. Each appRequest has multiple applications - one per program defined in the system. Some applications are mutually exclusive and/or will be eliminated early based on PREQUAL requirements, but they all technically exist in the data model - there is no concept of picking one application over another, just two applications where one dies and the other survives. */
 export interface Application {
     actions: ApplicationActions;
+    /** A brief description, written for applicants, of the program this application is for. */
+    applicantDescription: (Scalars['String'] | null);
     /** True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding. */
     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);
     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);
@@ -582,6 +586,10 @@ export interface PeriodActions {
 }
 export interface PeriodProgram {
     actions: PeriodProgramActions;
+    /** A brief description of the program, written for applicants. */
+    applicantDescription: (Scalars['String'] | null);
+    /** 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. */
     enabled: Scalars['Boolean'];
     key: Scalars['ID'];
@@ -637,6 +645,10 @@ export interface PeriodWorkflowStage {
     __typename: 'PeriodWorkflowStage';
 }
 export interface Program {
+    /** A brief description of the program, written for applicants. */
+    applicantDescription: (Scalars['String'] | null);
+    /** 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);
     key: Scalars['ID'];
     navTitle: Scalars['String'];
     title: Scalars['String'];
@@ -1182,8 +1194,12 @@ export interface AppRequestNoteFilters {
 /** An application represents the applicant applying to a specific program. Each appRequest has multiple applications - one per program defined in the system. Some applications are mutually exclusive and/or will be eliminated early based on PREQUAL requirements, but they all technically exist in the data model - there is no concept of picking one application over another, just two applications where one dies and the other survives. */
 export interface ApplicationGenqlSelection {
     actions?: ApplicationActionsGenqlSelection;
+    /** A brief description, written for applicants, of the program this application is for. */
+    applicantDescription?: boolean | number;
     /** True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding. */
     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;
     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;
@@ -1734,6 +1750,10 @@ export interface PeriodFilters {
 }
 export interface PeriodProgramGenqlSelection {
     actions?: PeriodProgramActionsGenqlSelection;
+    /** A brief description of the program, written for applicants. */
+    applicantDescription?: boolean | number;
+    /** 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. */
     enabled?: boolean | number;
     key?: boolean | number;
@@ -1801,6 +1821,10 @@ export interface PeriodWorkflowStageGenqlSelection {
     __scalar?: boolean | number;
 }
 export interface ProgramGenqlSelection {
+    /** A brief description of the program, written for applicants. */
+    applicantDescription?: boolean | number;
+    /** 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;
     key?: boolean | number;
     navTitle?: boolean | number;
     title?: boolean | number;

package/dist/typed-client/schema.graphql

@@ -749,10 +749,20 @@ An application represents the applicant applying to a specific program. Each app
 type Application {
   actions: ApplicationActions!
 
+  """
+  A brief description, written for applicants, of the program this application is for.
+  """
+  applicantDescription: String
+
   """
   True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding.
   """
   awaitingCorrection: 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: String
   id: ID!
 
   """
@@ -1518,6 +1528,14 @@ input PeriodFilters {
 type PeriodProgram {
   actions: PeriodProgramActions!
 
+  """A brief description of the program, written for applicants."""
+  applicantDescription: String
+
+  """
+  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: String
+
   """
   Whether the program is enabled in this period. This is set by the system administrator.
   """
@@ -1619,6 +1637,13 @@ type PeriodWorkflowStage {
 }
 
 type Program {
+  """A brief description of the program, written for applicants."""
+  applicantDescription: String
+
+  """
+  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: String
   key: ID!
   navTitle: String!
   title: String!

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

@@ -282,7 +282,9 @@ declare const _default: {
         AppRequestStatus: {};
         Application: {
             actions: number[];
+            applicantDescription: number[];
             awaitingCorrection: number[];
+            eligibilityDescription: number[];
             id: number[];
             ineligiblePhase: number[];
             navTitle: number[];
@@ -648,6 +650,8 @@ declare const _default: {
         };
         PeriodProgram: {
             actions: number[];
+            applicantDescription: number[];
+            eligibilityDescription: number[];
             enabled: number[];
             key: number[];
             navTitle: number[];
@@ -695,6 +699,8 @@ declare const _default: {
             __typename: number[];
         };
         Program: {
+            applicantDescription: number[];
+            eligibilityDescription: number[];
             key: number[];
             navTitle: number[];
             title: number[];

package/dist/typed-client/types.js

@@ -730,9 +730,15 @@ export default {
             "actions": [
                 34
             ],
+            "applicantDescription": [
+                85
+            ],
             "awaitingCorrection": [
                 41
             ],
+            "eligibilityDescription": [
+                85
+            ],
             "id": [
                 49
             ],
@@ -1713,6 +1719,12 @@ export default {
             "actions": [
                 70
             ],
+            "applicantDescription": [
+                85
+            ],
+            "eligibilityDescription": [
+                85
+            ],
             "enabled": [
                 41
             ],
@@ -1830,6 +1842,12 @@ export default {
             ]
         },
         "Program": {
+            "applicantDescription": [
+                85
+            ],
+            "eligibilityDescription": [
+                85
+            ],
             "key": [
                 49
             ],

package/dist/types.d.ts

@@ -43,6 +43,8 @@ export interface AppRequestForDetails {
 export interface ApplicationForDetails {
     id: string;
     title: string;
+    applicantDescription?: string | null;
+    eligibilityDescription?: string | null;
     ineligiblePhase: IneligiblePhases | null;
     status: ApplicationStatus;
     statusReason?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reqquest/ui",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "overrides": {
     "esrap": "2.3.2"
   },