fix(aggregate-choice-prompt): collect custom data (V4-1348)

- convert to custom prompt
- include into food-level in submission to be collected
- include in data-export

apps/admin/src/components/prompts/custom/index.ts

@@ -1,3 +1,4 @@
+import AggregateChoicePrompt from './aggregate-choice-prompt.vue';
 import CheckboxListPrompt from './checkbox-list-prompt.vue';
 import DatePickerPrompt from './date-picker-prompt.vue';
 import InfoPrompt from './info-prompt.vue';
@@ -10,9 +11,10 @@ import TimePickerPrompt from './time-picker-prompt.vue';
 import YesNoPrompt from './yes-no-prompt.vue';
 
 export default {
+  AggregateChoicePrompt,
+  CheckboxListPrompt,
   DatePickerPrompt,
   InfoPrompt,
-  CheckboxListPrompt,
   RadioListPrompt,
   SelectPrompt,
   SliderPrompt,

apps/admin/src/components/prompts/standard/index.ts

@@ -1,5 +1,4 @@
 import AddonFoodsPrompt from './addon-foods-prompt.vue';
-import AggregateChoicePrompt from './aggregate-choice-prompt.vue';
 import AssociatedFoodsPrompt from './associated-foods-prompt.vue';
 import EditMealPrompt from './edit-meal-prompt.vue';
 import ExternalSourcePrompt from './external-source-prompt.vue';
@@ -20,7 +19,6 @@ import SubmitPrompt from './submit-prompt.vue';
 
 export default {
   AddonFoodsPrompt,
-  AggregateChoicePrompt,
   AssociatedFoodsPrompt,
   GeneralAssociatedFoodsPrompt,
   EditMealPrompt,

apps/api/src/jobs/survey-schemes/survey-schemes-sync.ts

@@ -107,16 +107,17 @@ export default class SurveySchemesSync extends BaseJob<'SurveySchemesSync'> {
     const promptMap = this.getPromptMap();
 
     const mergeCallback = (prompt: SinglePrompt) => {
-      const baseMerge = merge<SinglePrompt>(promptMap[prompt.component], prompt);
+      const { component, type, ...rest } = prompt;
+      const { actions, conditions, ...baseMerge } = merge<SinglePrompt>(promptMap[prompt.component], rest);
       return {
         ...baseMerge,
-        actions: baseMerge.actions
+        actions: actions
           ? {
-              ...baseMerge.actions,
-              items: baseMerge.actions.items.map(action => merge(defaultAction, action)),
+              ...actions,
+              items: actions.items.map(action => merge(defaultAction, action)),
             }
           : undefined,
-        conditions: baseMerge.conditions.map(condition => merge<Condition>(getConditionDefaults(condition.object, condition.property.id), condition)),
+        conditions: conditions.map(condition => merge<Condition>(getConditionDefaults(condition.object, condition.property.id), condition)),
       };
     };
 

apps/api/src/services/admin/data-export/data-export-fields.ts

@@ -46,10 +46,10 @@ function dataExportFields() {
   /**
    * Helper to filter custom Prompt to ExportField
    *
-   * @param {Prompt} { type }
-   * @returns {boolean}
+   * @param {string} [component]
    */
-  const customPromptFilter = ({ type }: Prompt): boolean => type === 'custom';
+  const customPromptFilter = (component?: string) =>
+    (prompt: Prompt): boolean => prompt.type === 'custom' && (!component || prompt.component === component);
 
   /**
    * User fields
@@ -224,7 +224,7 @@ function dataExportFields() {
   const submissionCustom = async (surveyScheme: SurveyScheme): Promise<ExportField[]> => {
     const { preMeals, postMeals, submission } = surveyScheme.prompts;
     return [...preMeals, ...postMeals, ...submission]
-      .filter(customPromptFilter)
+      .filter(customPromptFilter())
       .map(customPromptMapper);
   };
 
@@ -258,7 +258,7 @@ function dataExportFields() {
       meals: { preFoods, postFoods },
     } = surveyScheme.prompts;
 
-    return [...preFoods, ...postFoods].filter(customPromptFilter).map(customPromptMapper);
+    return [...preFoods, ...postFoods].filter(customPromptFilter()).map(customPromptMapper);
   };
 
   /**
@@ -343,8 +343,13 @@ function dataExportFields() {
    *
    * @returns {Promise<ExportField[]>}
    */
-  const foodCustom = async (surveyScheme: SurveyScheme): Promise<ExportField[]> =>
-    surveyScheme.prompts.meals.foods.filter(customPromptFilter).map(customPromptMapper);
+  const foodCustom = async (surveyScheme: SurveyScheme): Promise<ExportField[]> => {
+    const { preMeals, postMeals, meals: { foods } } = surveyScheme.prompts;
+    return [
+      ...foods.filter(customPromptFilter()),
+      ...[...preMeals, ...postMeals].filter(customPromptFilter('aggregate-choice-prompt')),
+    ].map(customPromptMapper);
+  };
 
   /**
    * Food composition fields

apps/api/src/services/survey/survey-submission.service.ts

@@ -477,7 +477,10 @@ function surveySubmissionService({
       .filter(({ type }) => type === 'custom')
       .map(({ id }) => id);
 
-    const foodCustomPrompts = foods.filter(({ type }) => type === 'custom').map(({ id }) => id);
+    const foodCustomPrompts = [
+      ...foods.filter(({ type }) => type === 'custom').map(({ id }) => id),
+      ...[...preMeals, ...postMeals].filter(({ component, type }) => type === 'custom' && component === 'aggregate-choice-prompt').map(({ id }) => id),
+    ];
 
     await db.system.transaction(async (transaction) => {
       const { recallDate, startTime, endTime, userAgent } = state;

apps/survey/src/components/handlers/standard/AggregateChoicePromptHandler.vue → apps/survey/src/components/handlers/custom/AggregateChoicePromptHandler.vue

@@ -13,10 +13,9 @@ import { computed, defineComponent } from 'vue';
 import type { Prompts } from '@intake24/common/prompts';
 import type { PromptSection } from '@intake24/common/surveys';
 import type { FoodState } from '@intake24/common/types';
-import { AggregateChoicePrompt } from '@intake24/survey/components/prompts/standard';
-import { useSurvey } from '@intake24/survey/stores';
+import { AggregateChoicePrompt, filterMealsForAggregateChoicePrompt } from '@intake24/survey/components/prompts/custom';
 
-import { filterMealsForAggregateChoicePrompt } from '../../prompts/standard/aggregate-choice/aggregate-choice';
+import { useSurvey } from '@intake24/survey/stores';
 import { usePromptHandlerNoStore } from '../mixins';
 
 export default defineComponent({

apps/survey/src/components/handlers/custom/MultiCustomPromptHandler.vue → apps/survey/src/components/handlers/custom/MultiPromptHandler.vue

@@ -23,7 +23,7 @@ import { MultiPrompt } from '@intake24/survey/components/prompts';
 import { useCustomPromptHandler } from '../mixins';
 
 defineOptions({
-  name: 'MultiCustomPromptHandler',
+  name: 'MultiPromptHandler',
 });
 
 const props = defineProps({

apps/survey/src/components/handlers/custom/index.ts

@@ -1,7 +1,9 @@
+import AggregateChoicePromptHandler from './AggregateChoicePromptHandler.vue';
 import CustomPromptHandler from './CustomPromptHandler.vue';
-import MultiCustomPromptHandler from './MultiCustomPromptHandler.vue';
+import MultiPromptHandler from './MultiPromptHandler.vue';
 
 export default {
+  AggregateChoicePromptHandler,
   CustomPromptHandler,
-  MultiCustomPromptHandler,
+  MultiPromptHandler,
 };

apps/survey/src/components/handlers/standard/index.ts

@@ -1,5 +1,4 @@
 import AddonFoodsPromptHandler from './AddonFoodsPromptHandler.vue';
-import AggregateChoicePromptHandler from './AggregateChoicePromptHandler.vue';
 import AssociatedFoodsPromptHandler from './AssociatedFoodsPromptHandler.vue';
 import EditMealPromptHandler from './EditMealPromptHandler.vue';
 import ExternalSourcePromptHandler from './ExternalSourcePromptHandler.vue';
@@ -20,7 +19,6 @@ import SubmitPromptHandler from './SubmitPromptHandler.vue';
 
 export default {
   AddonFoodsPromptHandler,
-  AggregateChoicePromptHandler,
   AssociatedFoodsPromptHandler,
   GeneralAssociatedFoodsPromptHandler,
   EditMealPromptHandler,

apps/survey/src/components/prompts/standard/aggregate-choice/aggregate-choice.ts → apps/survey/src/components/prompts/custom/aggregate-choice/aggregate-choice.ts

@@ -1,10 +1,10 @@
-import type { AggregateChoicePrompt } from '@intake24/common/prompts';
+import type { Prompts } from '@intake24/common/prompts';
 import type { MealState } from '@intake24/common/types';
 import { evaluateCondition } from '@intake24/survey/dynamic-recall/prompt-manager';
 import type { SurveyStore } from '@intake24/survey/stores';
 import { flattenFoods } from '@intake24/survey/util/meal-food';
 
-export function filterMealsForAggregateChoicePrompt(surveyStore: SurveyStore, prompt: AggregateChoicePrompt): MealState[] {
+export function filterMealsForAggregateChoicePrompt(surveyStore: SurveyStore, prompt: Prompts['aggregate-choice-prompt']): MealState[] {
   return surveyStore.data.meals.map(meal => ({
     ...meal,
     foods: flattenFoods(meal.foods).filter((food) => {

apps/survey/src/components/prompts/custom/index.ts

@@ -9,6 +9,8 @@ import TextareaPrompt from './textarea-prompt.vue';
 import TimePickerPrompt from './time-picker-prompt.vue';
 import YesNoPrompt from './yes-no-prompt.vue';
 
+export * from './aggregate-choice';
+
 export default {
   CheckboxListPrompt,
   DatePickerPrompt,

apps/survey/src/components/prompts/standard/index.ts

@@ -1,5 +1,4 @@
 export { default as AddonFoodsPrompt } from './AddonFoodsPrompt.vue';
-export * from './aggregate-choice';
 export { default as AssociatedFoodsPrompt } from './AssociatedFoodsPrompt.vue';
 export { default as EditMealPrompt } from './EditMealPrompt.vue';
 export { default as ExternalSourcePrompt } from './ExternalSourcePrompt.vue';

apps/survey/src/components/recall/recall-mixin.ts

@@ -68,8 +68,8 @@ export default defineComponent({
 
       switch (prompt.type) {
         case 'custom':
-          return prompt.component === 'multi-prompt'
-            ? 'multi-custom-prompt-handler'
+          return ['multi-prompt', 'aggregate-choice-prompt'].includes(prompt.component)
+            ? `${prompt.component}-handler`
             : 'custom-prompt-handler';
         case 'standard':
         case 'portion-size':

apps/survey/src/dynamic-recall/prompt-manager.ts

@@ -32,8 +32,9 @@ import {
   recipeBuilderComplete,
   standardPortionComplete,
 } from '@intake24/common/util/portion-size-checks';
-import type { PromptInstance } from '@intake24/survey/dynamic-recall/dynamic-recall';
+import { filterMealsForAggregateChoicePrompt } from '@intake24/survey/components/prompts/custom';
 
+import type { PromptInstance } from '@intake24/survey/dynamic-recall/dynamic-recall';
 import {
   addonFoodPromptCheck,
   findMeal,
@@ -53,7 +54,6 @@ import {
   surveyPortionSizeComplete,
   surveySearchComplete,
 } from '@intake24/survey/util';
-import { filterMealsForAggregateChoicePrompt } from '../components/prompts/standard/aggregate-choice/aggregate-choice';
 import { recallLog } from '../stores';
 
 function foodEnergy(energy: number, food: FoodState): number {

docs/admin/surveys/prompt-types.md

@@ -385,6 +385,19 @@ Recipe builder prompt for foods with multiple ingredients, such as sandwiches, s
 
 Prompts with customizable generic behavior. Custom prompts can be used multiple times per scheme as long as they are identified with scheme-unique [`Prompt ID`](/admin/surveys/prompt-editor#general).
 
+### Aggregate choice prompt
+
+Prompt to collect single option from a list of foods.
+
+#### Options
+
+- `options` - locale-specific list of options with properties:
+
+  - `label` - user-facing displayed label
+  - `value` - value stored in database
+
+- `as only for specified foods` - conditions to limit the foods to which the prompt is applicable
+
 ### Checkbox list prompt
 
 Multi-select list of options.
@@ -393,8 +406,8 @@ Multi-select list of options.
 
 - `options` - locale-specific list of options with properties:
 
-  - `label` - (user-facing displayed value)
-  - `value` - (value stored in database) can be specified
+  - `label` - user-facing displayed label
+  - `value` - value stored in database
   - `exclusive` - exclusive flag - if selected, other options are deselected
 
 - `other` - `true` or `false` whether to show 'other' option, free-form text input
@@ -427,8 +440,8 @@ Prompt to collect single or multiple option(s) from a list of options using sele
 
 - `options` - locale-specific list of options with properties:
 
-  - `label` (user-facing displayed value)
-  - `value` (value stored in database) can be specified
+  - `label` - user-facing displayed label
+  - `value` - value stored in database
 
 ### Slider prompt
 
@@ -454,8 +467,8 @@ Single-select list of options.
 
 - `options` - locale-specific list of options with properties:
 
-  - `label` (user-facing displayed value)
-  - `value` (value stored in database) can be specified
+  - `label` - user-facing displayed label
+  - `value` - value stored in database
 
 - `other` - `true` or `false` whether to show 'other' option, free-form text input
 

packages/common/src/prompts/custom.ts

@@ -3,6 +3,16 @@ import type { Prompts } from './prompts';
 import { copy } from '@intake24/common/util';
 import { basePrompt, promptValidation } from './base';
 
+export const aggregateChoicePrompt: Prompts['aggregate-choice-prompt'] = copy({
+  ...basePrompt,
+  component: 'aggregate-choice-prompt',
+  type: 'custom',
+  id: 'aggregate-choice-prompt',
+  name: 'Aggregate choice question prompt',
+  options: { en: [] },
+  foodFilter: undefined,
+});
+
 export const checkboxListPrompt: Prompts['checkbox-list-prompt'] = copy({
   ...basePrompt,
   ...promptValidation,
@@ -110,6 +120,7 @@ export const yesNoPrompt: Prompts['yes-no-prompt'] = copy({
 });
 
 export const customPrompts = [
+  aggregateChoicePrompt,
   checkboxListPrompt,
   datePickerPrompt,
   infoPrompt,

packages/common/src/prompts/prompts.ts

@@ -27,12 +27,10 @@ export const customComponentTypes = [
   'yes-no-prompt',
   'aggregate-choice-prompt',
 ] as const;
-
 export type CustomComponentType = (typeof customComponentTypes)[number];
 
 export const standardComponentTypes = [
   'addon-foods-prompt',
-  'aggregate-choice-prompt',
   'associated-foods-prompt',
   'general-associated-foods-prompt',
   'edit-meal-prompt',
@@ -51,7 +49,6 @@ export const standardComponentTypes = [
   'split-food-prompt',
   'submit-prompt',
 ] as const;
-
 export type StandardComponentType = (typeof standardComponentTypes)[number];
 
 export type PortionSizeComponentType =
@@ -198,15 +195,13 @@ export const timePicker = z.object({
 });
 export type TimePicker = z.infer<typeof timePicker>;
 
-const aggregateChoicePrompt = baseStandardPrompt.extend({
+// Custom
+const aggregateChoicePrompt = baseCustomPrompt.extend({
   component: z.literal('aggregate-choice-prompt'),
   options: localeOptionList(),
   foodFilter: condition.optional(),
 });
 
-export type AggregateChoicePrompt = z.infer<typeof aggregateChoicePrompt>;
-
-// Custom
 const checkboxListPrompt = baseCustomPrompt
   .extend({
     component: z.literal('checkbox-list-prompt'),
@@ -436,6 +431,7 @@ const submitPrompt = baseStandardPrompt.extend({
 
 export const singlePrompt = z.discriminatedUnion('component', [
   // Custom
+  aggregateChoicePrompt,
   checkboxListPrompt,
   datePickerPrompt,
   infoPrompt,
@@ -480,7 +476,6 @@ export const singlePrompt = z.discriminatedUnion('component', [
   sameAsBeforePrompt,
   splitFoodPrompt,
   submitPrompt,
-  aggregateChoicePrompt,
 ]);
 export type SinglePrompt = z.infer<typeof singlePrompt>;
 

packages/common/src/prompts/standard.ts

@@ -194,16 +194,6 @@ export const submitPrompt: Prompts['submit-prompt'] = copy({
   },
 });
 
-export const aggregateChoicePrompt: Prompts['aggregate-choice-prompt'] = copy({
-  ...basePrompt,
-  component: 'aggregate-choice-prompt',
-  type: 'standard',
-  id: 'aggregate-choice-prompt',
-  name: 'Aggregate food question prompt',
-  options: { en: [] },
-  foodFilter: undefined,
-});
-
 export const generalAssociatedFoodsPrompt: Prompts['general-associated-foods-prompt'] = copy({
   ...basePrompt,
   component: 'general-associated-foods-prompt',
@@ -237,5 +227,4 @@ export const standardPrompts = [
   sameAsBeforePrompt,
   splitFoodPrompt,
   submitPrompt,
-  aggregateChoicePrompt,
 ];

packages/i18n/src/admin/en/survey-schemes.json

@@ -645,7 +645,7 @@
       "subtitle": "Ask to choose yes or no"
     },
     "aggregate-choice-prompt": {
-      "title": "Aggregate food question",
+      "title": "Aggregate choice question",
       "subtitle": "Ask to choose an option for every reported food in a single screen"
     },
     "as-served-prompt": {