@reqquest/ui 1.12.0 → 1.12.1

package/README.md

@@ -2,7 +2,29 @@
 
 This library provides a set of Svelte components and utilities for building ReqQuest projects. You'll especially find the `api` useful for creating graphQL queries. In the future we will provide a small component library to help you build your prompts.
 
-# Developing
+## Registering your prompts
+
+Every prompt your API defines needs a Svelte component registered here, and nothing links the two
+automatically. Use the keyed form of `UIConfig` so a prompt you forget to register is a build error
+rather than a broken screen:
+
+```ts
+const config = {
+  appName: 'My Program',
+  prompts: {
+    proof_of_residence_prompt: { formComponent: ResidencePrompt, displayComponent: ResidenceDisplay }
+  }
+} satisfies UIConfig
+export const uiRegistry = new UIRegistry(config)
+```
+
+That check only has teeth once a key declaration augmenting `@reqquest/ui` is in your `src`. It is
+generated on the **API** side, by the analyzer that ships with `@reqquest/api` — see
+[docs/downstream-setup.md](../docs/downstream-setup.md). Without it, keys stay `string`, an
+unregistered prompt renders an inline "unavailable" notice at runtime, and you find out when a user
+reaches the screen.
+
+# Developing this library
 
 To develop the UI library, you'll want to work with the full demo, so `docker compose up --build` in the root of the repo. Similarly the test suite is combined with API tests, so run `./test.sh` in the root of the repo.
 

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

@@ -767,6 +767,8 @@ export interface RequirementPrompt {
     moot: Scalars['Boolean'];
     /** 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: Scalars['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: Scalars['Boolean'];
     optOut: Scalars['Boolean'];
     /** Preload data that has been generated according to the prompt definition. For example, a prompt might query the database for answers given in previous requests or query an external API to learn facts about the user. */
     preloadData: (Scalars['JsonData'] | null);
@@ -1107,7 +1109,7 @@ export interface AnnouncementUpdate {
     /** Short headline for the announcement. */
     subject?: (Scalars['String'] | null);
     /** The type of announcement, toggleable or date range */
-    type?: (Scalars['Boolean'] | null);
+    type?: (Scalars['String'] | null);
 }
 /** 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. */
 export interface AppRequestGenqlSelection {
@@ -2122,6 +2124,8 @@ export interface RequirementPromptGenqlSelection {
     moot?: boolean | number;
     /** 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?: boolean | number;
+    /** 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 | number;
     optOut?: boolean | number;
     /** Preload data that has been generated according to the prompt definition. For example, a prompt might query the database for answers given in previous requests or query an external API to learn facts about the user. */
     preloadData?: {

package/dist/typed-client/schema.graphql

@@ -363,7 +363,7 @@ input AnnouncementUpdate {
   subject: String
 
   """The type of announcement, toggleable or date range"""
-  type: Boolean
+  type: String
 }
 
 """
@@ -1954,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!
 
   """

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

@@ -838,6 +838,7 @@ declare const _default: {
             key: number[];
             moot: number[];
             navTitle: number[];
+            noDisplay: number[];
             optOut: number[];
             preloadData: (number | {
                 schemaVersion: number[];

package/dist/typed-client/types.js

@@ -487,7 +487,7 @@ export default {
                 89
             ],
             "type": [
-                45
+                89
             ],
             "__typename": [
                 89
@@ -1004,10 +1004,7 @@ export default {
                 36
             ],
             "blame": [
-                86
-            ],
-            "blame": [
-                86
+                89
             ],
             "configurationData": [
                 58
@@ -2227,6 +2224,9 @@ export default {
             "navTitle": [
                 89
             ],
+            "noDisplay": [
+                45
+            ],
             "optOut": [
                 45
             ],

package/package.json

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