feat: Recipe Finder (aka Cocktail Builder) (mealie-recipes#4542)

frontend/assets/css/main.css

@@ -48,3 +48,11 @@
 .v-card__title {
   word-break: normal !important;
 }
+
+.text-hide-overflow {
+  display: inline-block;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  max-width: 100%;
+}

frontend/components/Domain/QueryFilterBuilder.vue

@@ -253,7 +253,7 @@
       </v-container>
     </v-card-text>
     <v-card-actions>
-      <v-container fluid class="d-flex justify-end pa-0">
+      <v-container fluid class="d-flex justify-end pa-0 mx-2">
         <v-checkbox
           v-model="showAdvanced"
           hide-details
@@ -431,6 +431,7 @@ export default defineComponent({
         state.qfValid = !!qf;
 
         context.emit("input", qf || undefined);
+        context.emit("inputJSON", qf ? buildQueryFilterJSON() : undefined);
       },
       {
         deep: true
@@ -543,6 +544,32 @@ export default defineComponent({
       initFieldsError(`Error initializing fields: ${(error || "").toString()}`);
     }
 
+    function buildQueryFilterJSON(): QueryFilterJSON {
+      const parts = fields.value.map((field) => {
+        const part: QueryFilterJSONPart = {
+          attributeName: field.name,
+          leftParenthesis: field.leftParenthesis,
+          rightParenthesis: field.rightParenthesis,
+          logicalOperator: field.logicalOperator?.value,
+          relationalOperator: field.relationalOperatorValue?.value,
+        };
+
+        if (field.fieldOptions?.length || isOrganizerType(field.type)) {
+          part.value = field.values.map((value) => value.toString());
+        } else if (field.type === "boolean") {
+          part.value = field.value ? "true" : "false";
+        } else {
+          part.value = (field.value || "").toString();
+        }
+
+        return part;
+      });
+
+      const qfJSON = { parts } as QueryFilterJSON;
+      console.debug(`Built query filter JSON: ${JSON.stringify(qfJSON)}`);
+      return qfJSON;
+    }
+
 
     const attrs = computed(() => {
       const baseColMaxWidth = 55;

frontend/components/Domain/Recipe/RecipeSuggestion.vue

@@ -0,0 +1,118 @@
+<template>
+  <v-container class="elevation-3">
+    <v-row no-gutters>
+      <v-col cols="12">
+        <RecipeCardMobile
+          :name="recipe.name"
+          :description="recipe.description"
+          :slug="recipe.slug"
+          :rating="recipe.rating"
+          :image="recipe.image"
+          :recipe-id="recipe.id"
+        />
+      </v-col>
+      <div v-for="(organizer, idx) in missingOrganizers" :key="idx">
+        <v-col
+          v-if="organizer.show"
+          cols="12"
+        >
+          <div class="d-flex flex-row flex-wrap align-center pt-2">
+            <v-icon class="ma-0 pa-0">{{ organizer.icon }}</v-icon>
+            <v-card-text class="mr-0 my-0 pl-1 py-0" style="width: min-content;">
+              {{ $tc("recipe-finder.missing") }}:
+            </v-card-text>
+            <v-chip
+              v-for="item in organizer.items"
+              :key="item.item.id"
+              label
+              color="secondary custom-transparent"
+              class="mr-2 my-1"
+            >
+              <v-checkbox dark :ripple="false" @click="handleCheckbox(item)">
+                <template #label>
+                  {{ organizer.getLabel(item.item) }}
+                </template>
+              </v-checkbox>
+            </v-chip>
+          </div>
+        </v-col>
+      </div>
+    </v-row>
+  </v-container>
+</template>
+
+<script lang="ts">
+import { computed, defineComponent, reactive, useContext } from "@nuxtjs/composition-api";
+import RecipeCardMobile from "./RecipeCardMobile.vue";
+import { IngredientFood, RecipeSummary, RecipeTool } from "~/lib/api/types/recipe";
+
+interface Organizer {
+  type: "food" | "tool";
+  item: IngredientFood | RecipeTool;
+  selected: boolean;
+}
+
+export default defineComponent({
+  components: { RecipeCardMobile },
+  props: {
+    recipe: {
+      type: Object as () => RecipeSummary,
+      required: true,
+    },
+    missingFoods: {
+      type: Array as () => IngredientFood[] | null,
+      default: null,
+    },
+    missingTools: {
+      type: Array as () => RecipeTool[] | null,
+      default: null,
+    },
+    disableCheckbox: {
+      type: Boolean,
+      default: false,
+    },
+  },
+  setup(props, context) {
+    const { $globals } = useContext();
+    const missingOrganizers = computed(() => [
+      {
+        type: "food",
+        show: props.missingFoods?.length,
+        icon: $globals.icons.foods,
+        items: props.missingFoods ? props.missingFoods.map((food) => {
+          return reactive({type: "food", item: food, selected: false} as Organizer);
+        }) : [],
+        getLabel: (item: IngredientFood) => item.pluralName || item.name,
+      },
+      {
+        type: "tool",
+        show: props.missingTools?.length,
+        icon: $globals.icons.tools,
+        items: props.missingTools ? props.missingTools.map((tool) => {
+          return reactive({type: "tool", item: tool, selected: false} as Organizer);
+        }) : [],
+        getLabel: (item: RecipeTool) => item.name,
+      }
+    ])
+
+    function handleCheckbox(organizer: Organizer) {
+      if (props.disableCheckbox) {
+        return;
+      }
+
+      organizer.selected = !organizer.selected;
+      if (organizer.selected) {
+        context.emit(`add-${organizer.type}`, organizer.item);
+      }
+      else {
+        context.emit(`remove-${organizer.type}`, organizer.item);
+      }
+    }
+
+    return {
+      missingOrganizers,
+      handleCheckbox,
+    };
+  }
+});
+</script>

frontend/components/Layout/DefaultLayout.vue

@@ -221,7 +221,13 @@ export default defineComponent({
         icon: $globals.icons.silverwareForkKnife,
         to: `/g/${groupSlug.value}`,
         title: i18n.tc("general.recipes"),
-        restricted: true,
+        restricted: false,
+      },
+      {
+        icon: $globals.icons.search,
+        to: `/g/${groupSlug.value}/recipes/finder`,
+        title: i18n.tc("recipe-finder.recipe-finder"),
+        restricted: false,
       },
       {
         icon: $globals.icons.calendarMultiselect,

frontend/components/global/BaseDialog.vue

@@ -45,11 +45,13 @@
             </v-btn>
             <v-spacer></v-spacer>
 
+            <slot name="custom-card-action"></slot>
             <BaseButton v-if="$listeners.delete" delete secondary @click="deleteEvent" />
             <BaseButton
               v-if="$listeners.confirm"
               :color="color"
               type="submit"
+              :disabled="submitDisabled"
               @click="
                 $emit('confirm');
                 dialog = false;
@@ -60,8 +62,12 @@
               </template>
               {{ $t("general.confirm") }}
             </BaseButton>
-            <slot name="custom-card-action"></slot>
-            <BaseButton v-if="$listeners.submit" type="submit" :disabled="submitDisabled" @click="submitEvent">
+            <BaseButton
+              v-if="$listeners.submit"
+              type="submit"
+              :disabled="submitDisabled"
+              @click="submitEvent"
+            >
               {{ submitText }}
               <template v-if="submitIcon" #icon>
                 {{ submitIcon }}

frontend/composables/use-users/preferences.ts

@@ -1,6 +1,7 @@
 import { Ref, useContext } from "@nuxtjs/composition-api";
 import { useLocalStorage, useSessionStorage } from "@vueuse/core";
 import { RegisteredParser, TimelineEventType } from "~/lib/api/types/recipe";
+import { QueryFilterJSON } from "~/lib/api/types/response";
 
 export interface UserPrintPreferences {
   imagePosition: string;
@@ -49,6 +50,17 @@ export interface UserCookbooksPreferences {
   hideOtherHouseholds: boolean;
 }
 
+export interface UserRecipeFinderPreferences {
+  foodIds: string[];
+  toolIds: string[];
+  queryFilter: string;
+  queryFilterJSON: QueryFilterJSON;
+  maxMissingFoods: number;
+  maxMissingTools: number;
+  includeFoodsOnHand: boolean;
+  includeToolsOnHand: boolean;
+}
+
 export function useUserMealPlanPreferences(): Ref<UserMealPlanPreferences> {
   const fromStorage = useLocalStorage(
     "meal-planner-preferences",
@@ -171,3 +183,24 @@ export function useCookbookPreferences(): Ref<UserCookbooksPreferences> {
 
   return fromStorage;
 }
+
+export function useRecipeFinderPreferences(): Ref<UserRecipeFinderPreferences> {
+  const fromStorage = useLocalStorage(
+    "recipe-finder-preferences",
+    {
+      foodIds: [],
+      toolIds: [],
+      queryFilter: "",
+      queryFilterJSON: { parts: [] } as QueryFilterJSON,
+      maxMissingFoods: 20,
+      maxMissingTools: 20,
+      includeFoodsOnHand: true,
+      includeToolsOnHand: true,
+    },
+    { mergeDefaults: true }
+    // we cast to a Ref because by default it will return an optional type ref
+    // but since we pass defaults we know all properties are set.
+  ) as unknown as Ref<UserRecipeFinderPreferences>;
+
+  return fromStorage;
+}

frontend/lang/messages/en-US.json

@@ -671,6 +671,23 @@
     "reset-servings-count": "Reset Servings Count",
     "not-linked-ingredients": "Additional Ingredients"
   },
+  "recipe-finder": {
+    "recipe-finder": "Recipe Finder",
+    "recipe-finder-description": "Search for recipes based on ingredients you have on hand. You can also filter by tools you have available, and set a maximum number of missing ingredients or tools.",
+    "selected-ingredients": "Selected Ingredients",
+    "no-ingredients-selected": "No ingredients selected",
+    "missing": "Missing",
+    "no-recipes-found": "No recipes found",
+    "no-recipes-found-description": "Try adding more ingredients to your search or adjusting your filters",
+    "include-ingredients-on-hand": "Include Ingredients On Hand",
+    "include-tools-on-hand": "Include Tools On Hand",
+    "max-missing-ingredients": "Max Missing Ingredients",
+    "max-missing-tools": "Max Missing Tools",
+    "selected-tools": "Selected Tools",
+    "other-filters": "Other Filters",
+    "ready-to-make": "Ready to Make",
+    "almost-ready-to-make": "Almost Ready to Make"
+  },
   "search": {
     "advanced-search": "Advanced Search",
     "and": "and",

frontend/lib/api/public/explore/recipes.ts

@@ -1,6 +1,6 @@
 import { BaseCRUDAPIReadOnly } from "~/lib/api/base/base-clients";
 import { route } from "../../base";
-import { Recipe } from "~/lib/api/types/recipe";
+import { Recipe, RecipeSuggestionQuery, RecipeSuggestionResponse } from "~/lib/api/types/recipe";
 import { ApiRequestInstance, PaginationData } from "~/lib/api/types/non-generated";
 import { RecipeSearchQuery } from "../../user/recipes/recipe";
 
@@ -23,4 +23,10 @@ export class PublicRecipeApi extends BaseCRUDAPIReadOnly<Recipe> {
   async search(rsq: RecipeSearchQuery) {
     return await this.requests.get<PaginationData<Recipe>>(route(routes.recipesGroupSlug(this.groupSlug), rsq));
   }
+
+  async getSuggestions(q: RecipeSuggestionQuery, foods: string[] | null = null, tools: string[]| null = null) {
+    return await this.requests.get<RecipeSuggestionResponse>(
+      route(`${this.baseRoute}/suggestions`, { ...q, foods, tools })
+    );
+  }
 }

frontend/lib/api/types/recipe.ts

@@ -7,6 +7,8 @@
 
 export type ExportTypes = "json";
 export type RegisteredParser = "nlp" | "brute" | "openai";
+export type OrderByNullPosition = "first" | "last";
+export type OrderDirection = "asc" | "desc";
 export type TimelineEventType = "system" | "info" | "comment";
 export type TimelineEventImage = "has image" | "does not have image";
 
@@ -380,6 +382,26 @@ export interface RecipeShareTokenSummary {
 export interface RecipeSlug {
   slug: string;
 }
+export interface RecipeSuggestionQuery {
+  orderBy?: string | null;
+  orderByNullPosition?: OrderByNullPosition | null;
+  orderDirection?: OrderDirection;
+  queryFilter?: string | null;
+  paginationSeed?: string | null;
+  limit?: number;
+  maxMissingFoods?: number;
+  maxMissingTools?: number;
+  includeFoodsOnHand?: boolean;
+  includeToolsOnHand?: boolean;
+}
+export interface RecipeSuggestionResponse {
+  items: RecipeSuggestionResponseItem[];
+}
+export interface RecipeSuggestionResponseItem {
+  recipe: RecipeSummary;
+  missingFoods: IngredientFood[];
+  missingTools: RecipeTool[];
+}
 export interface RecipeTagResponse {
   name: string;
   id: string;
@@ -519,3 +541,10 @@ export interface UnitFoodBase {
 export interface UpdateImageResponse {
   image: string;
 }
+export interface RequestQuery {
+  orderBy?: string | null;
+  orderByNullPosition?: OrderByNullPosition | null;
+  orderDirection?: OrderDirection;
+  queryFilter?: string | null;
+  paginationSeed?: string | null;
+}

frontend/lib/api/types/response.ts

@@ -20,13 +20,13 @@ export interface FileTokenResponse {
   fileToken: string;
 }
 export interface PaginationQuery {
-  page?: number;
-  perPage?: number;
   orderBy?: string | null;
   orderByNullPosition?: OrderByNullPosition | null;
   orderDirection?: OrderDirection;
   queryFilter?: string | null;
   paginationSeed?: string | null;
+  page?: number;
+  perPage?: number;
 }
 export interface QueryFilterJSON {
   parts?: QueryFilterJSONPart[];
@@ -47,6 +47,13 @@ export interface RecipeSearchQuery {
   requireAllFoods?: boolean;
   search?: string | null;
 }
+export interface RequestQuery {
+  orderBy?: string | null;
+  orderByNullPosition?: OrderByNullPosition | null;
+  orderDirection?: OrderDirection;
+  queryFilter?: string | null;
+  paginationSeed?: string | null;
+}
 export interface SuccessResponse {
   message: string;
   error?: boolean;