Merge branch 'mealie-next' into feat/use-backend-for-recipe-post-actions

mealie-recipes · Sep 14, 2024 · c259042 · c259042
2 parents efd1284 + 8bd26d2
commit c259042
Show file tree

Hide file tree

Showing 31 changed files with 886 additions and 460 deletions.
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -50,8 +50,22 @@ version-resolver:
   default: patch
 
 template: |
-  # 🍴🍴🍴🍴🍴🍴🍴🍴🍴🍴
+  # 🍴🍴🍴🍴🍴🍴
 
   $CHANGES
 
-  # 🍴🍴🍴🍴🍴🍴🍴🍴🍴🍴
+  # 🍴🍴🍴🍴🍴🍴
+
+autolabeler:
+  - label: 'feature'
+    title:
+      - '/feat/i'
+  - label: 'bugfix'
+    title:
+      - '/fix:/i'
+  - label: 'documentation'
+    title:
+      - '/docs:/i'
+  - label: 'chore'
+    title:
+      - '/chore:/i'
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -5,13 +5,22 @@ on:
   push:
     branches:
       - mealie-next
+  # pull_request event is required for autolabeler
+  pull_request:
+    types: [opened, labeled, unlabeled, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  pull_request_target:
+    types: [opened, labeled, unlabeled, reopened, synchronize]
   workflow_dispatch:
 
 jobs:
   update_release_draft:
     permissions:
       # write permission is required to create a github release
       contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
     name: ✏️ Draft release
     runs-on: ubuntu-latest
     steps:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -12,7 +12,7 @@ repos:
         exclude: ^tests/data/
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.6.3
+    rev: v0.6.4
     hooks:
       - id: ruff
       - id: ruff-format
diff --git a/docs/docs/documentation/getting-started/faq.md b/docs/docs/documentation/getting-started/faq.md
@@ -149,3 +149,11 @@ As to why we need a database?
 
 - **Developer Experience:** Without a database, a lot of the work to maintain your data is taken on by the developer instead of a battle-tested platform for storing data.
 - **Multi User Support:** With a solid database as backend storage for your data, Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time.
+
+## Why is there no "Keep Screen Alive" button when I access a recipe?
+You've perhaps visited the Mealie Demo and noticed that it had a "Keep Screen Alive" button, but it doesn't show up in your own Mealie instance.
+There are typically two possible reasons for this:
+1. You're accessing your Mealie instance without using HTTPS. The Wake Lock API is only available if HTTPS is used. Read more here: https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API
+2. You're accessing your Mealie instance on a browser which doesn't support the API. You can test this here: https://vueuse.org/core/useWakeLock/#demo
+
+Solving the above points will most likely resolve your issues. However, if you're still having problems, you are welcome to create an issue. Just remember to add that you've tried the above two options first in your description.
diff --git a/docs/docs/documentation/getting-started/installation/backend-config.md b/docs/docs/documentation/getting-started/installation/backend-config.md
@@ -104,7 +104,7 @@ For usage, see [Usage - OpenID Connect](../authentication/oidc.md)
 
 :octicons-tag-24: v1.7.0
 
-Mealie supports various integrations using OpenAI. To enable OpenAI, [you must provide your OpenAI API key](https://platform.openai.com/api-keys). You can tweak how OpenAI is used using these backend settings. Please note that while OpenAI usage is optimized to reduce API costs, you're unlikely to be able to use OpenAI features with the free tier limits.
+Mealie supports various integrations using OpenAI. For more information, check out our [OpenAI documentation](./open-ai.md).
 
 | Variables                    | Default | Description                                                                                                                                                                  |
 | ---------------------------- | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/docs/documentation/getting-started/installation/open-ai.md b/docs/docs/documentation/getting-started/installation/open-ai.md
@@ -0,0 +1,18 @@
+# OpenAI Integration
+
+:octicons-tag-24: v1.7.0
+
+Mealie's OpenAI integration enables several features and enhancements throughout the application. To enable OpenAI features, you must have an account with OpenAI and configure Mealie to use the OpenAI API key (for more information, check out the [backend configuration](./backend-config.md#openai)).
+
+## Configuration
+
+For most users, supplying the OpenAI API key is all you need to do; you will use the regular OpenAI service with the default language model. Note that while OpenAI has a free tier, it's not sufficiently capable for Mealie (or most other production use cases). For more information, check out [OpenAI's rate limits](https://platform.openai.com/docs/guides/rate-limits). If you deposit $5 into your OpenAI account, you will be permanently bumped up to Tier 1, which is sufficient for Mealie. Cost per-request is dependant on many factors, but Mealie tries to keep token counts conservative.
+
+Alternatively, if you have another service you'd like to use in-place of OpenAI, you can configure Mealie to use that instead, as long as it has an OpenAI-compatible API. For instance, a common self-hosted alternative to OpenAI is [Ollama](https://ollama.com/). To use Ollama with Mealie, change your `OPENAI_BASE_URL` to `http://localhost:11434/v1` (where `http://localhost:11434` is wherever you're hosting Ollama, and `/v1` enables the OpenAI-compatible endpoints). Note that you *must* provide an API key, even though it is ultimately ignored by Ollama.
+
+If you wish to disable image recognition features (to save costs, or because your custom model doesn't support them) you can set `OPENAI_ENABLE_IMAGE_SERVICES` to `False`. For more information on what configuration options are available, check out the [backend configuration](./backend-config.md#openai).
+
+## OpenAI Features
+- The OpenAI Ingredient Parser can be used as an alternative to the NLP and Brute Force parsers. Simply choose the OpenAI parser while parsing ingredients (:octicons-tag-24: v1.7.0)
+- When importing a recipe via URL, if the default recipe scraper is unable to read the recipe data from a webpage, the webpage contents will be parsed by OpenAI (:octicons-tag-24: v1.9.0)
+- You can import an image of a written recipe, which is sent to OpenAI and imported into Mealie. The recipe can be hand-written or typed, as long as the text is in the picture. You can also optionally have OpenAI translate the recipe into your own language (:octicons-tag-24: v1.12.0)
diff --git a/docs/docs/documentation/getting-started/installation/postgres.md b/docs/docs/documentation/getting-started/installation/postgres.md
@@ -20,7 +20,7 @@ services:
       - mealie-data:/app/data/
     environment:
       # Set Backend ENV Variables Here
-      ALLOW_SIGNUP: false
+      ALLOW_SIGNUP: "false"
       PUID: 1000
       PGID: 1000
       TZ: America/Anchorage

diff --git a/docs/docs/documentation/getting-started/installation/sqlite.md b/docs/docs/documentation/getting-started/installation/sqlite.md
@@ -24,7 +24,7 @@ services:
       - mealie-data:/app/data/
     environment:
       # Set Backend ENV Variables Here
-      ALLOW_SIGNUP: false
+      ALLOW_SIGNUP: "false"
       PUID: 1000
       PGID: 1000
       TZ: America/Anchorage

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -74,6 +74,7 @@ nav:
           - Backend Configuration: "documentation/getting-started/installation/backend-config.md"
           - Security: "documentation/getting-started/installation/security.md"
           - Logs: "documentation/getting-started/installation/logs.md"
+          - OpenAI: "documentation/getting-started/installation/open-ai.md"
       - Usage:
           - Backup and Restoring: "documentation/getting-started/usage/backups-and-restoring.md"
           - Permissions and Public Access: "documentation/getting-started/usage/permissions-and-public-access.md"

diff --git a/frontend/components/Domain/Recipe/RecipeCardMobile.vue b/frontend/components/Domain/Recipe/RecipeCardMobile.vue
@@ -1,83 +1,85 @@
 <template>
-  <v-expand-transition>
-    <v-card
-      :ripple="false"
-      :class="isFlat ? 'mx-auto flat' : 'mx-auto'"
-      :style="{ cursor }"
-      hover
-      :to="$listeners.selected ? undefined : recipeRoute"
-      @click="$emit('selected')"
-    >
-      <v-img v-if="vertical" class="rounded-sm">
-        <RecipeCardImage
-          :icon-size="100"
-          :height="150"
-          :slug="slug"
-          :recipe-id="recipeId"
-          small
-          :image-version="image"
-        />
-      </v-img>
-      <v-list-item three-line :class="vertical ? 'px-2' : 'px-0'">
-        <slot v-if="!vertical" name="avatar">
-          <v-list-item-avatar tile width="125" height="avatarSize" class="v-mobile-img rounded-sm my-0">
-            <RecipeCardImage
-              :icon-size="100"
-              :height="avatarSize"
-              :slug="slug"
-              :recipe-id="recipeId"
-              :image-version="image"
-              small
-            />
-          </v-list-item-avatar>
-        </slot>
-        <v-list-item-content class="py-0">
-          <v-list-item-title class="mt-3 mb-1">{{ name }} </v-list-item-title>
-          <v-list-item-subtitle>
-            <SafeMarkdown :source="description" />
-          </v-list-item-subtitle>
-          <div class="d-flex flex-wrap justify-start">
-            <RecipeChips :truncate="true" :items="tags" :title="false" :limit="2" :small="true" url-prefix="tags" />
-          </div>
-          <div class="d-flex flex-wrap justify-end align-center">
-            <slot name="actions">
-              <RecipeFavoriteBadge v-if="isOwnGroup && showRecipeContent" :recipe-id="recipeId" show-always />
-              <RecipeRating
-                :class="isOwnGroup ? 'ml-auto' : 'ml-auto pb-2'"
-                :value="rating"
-                :recipe-id="recipeId"
-                :slug="slug"
-                :small="true"
-              />
-              <v-spacer></v-spacer>
-
-              <!-- If we're not logged-in, no items display, so we hide this menu -->
-              <!-- We also add padding to the v-rating above to compensate -->
-              <RecipeContextMenu
-                v-if="isOwnGroup && showRecipeContent"
+  <div :style="`height: ${height}`">
+    <v-expand-transition>
+      <v-card
+        :ripple="false"
+        :class="isFlat ? 'mx-auto flat' : 'mx-auto'"
+        :style="{ cursor }"
+        hover
+        :to="$listeners.selected ? undefined : recipeRoute"
+        @click="$emit('selected')"
+      >
+        <v-img v-if="vertical" class="rounded-sm">
+          <RecipeCardImage
+            :icon-size="100"
+            :height="height"
+            :slug="slug"
+            :recipe-id="recipeId"
+            small
+            :image-version="image"
+          />
+        </v-img>
+        <v-list-item three-line :class="vertical ? 'px-2' : 'px-0'">
+          <slot v-if="!vertical" name="avatar">
+            <v-list-item-avatar tile :height="height" width="125" class="v-mobile-img rounded-sm my-0">
+              <RecipeCardImage
+                :icon-size="100"
+                :height="height"
                 :slug="slug"
-                :menu-icon="$globals.icons.dotsHorizontal"
-                :name="name"
                 :recipe-id="recipeId"
-                :use-items="{
-                  delete: false,
-                  edit: true,
-                  download: true,
-                  mealplanner: true,
-                  shoppingList: true,
-                  print: false,
-                  printPreferences: false,
-                  share: true,
-                }"
-                @deleted="$emit('delete', slug)"
+                :image-version="image"
+                small
               />
-            </slot>
-          </div>
-        </v-list-item-content>
-      </v-list-item>
-      <slot />
-    </v-card>
-  </v-expand-transition>
+            </v-list-item-avatar>
+          </slot>
+          <v-list-item-content class="py-0">
+            <v-list-item-title class="mt-1 mb-1 text-top">{{ name }}</v-list-item-title>
+            <v-list-item-subtitle class="ma-0 text-top">
+              <SafeMarkdown :source="description" />
+            </v-list-item-subtitle>
+            <div class="d-flex flex-wrap justify-start ma-0">
+              <RecipeChips :truncate="true" :items="tags" :title="false" :limit="2" :small="true" url-prefix="tags" />
+            </div>
+            <div class="d-flex flex-wrap justify-end align-center">
+              <slot name="actions">
+                <RecipeFavoriteBadge v-if="isOwnGroup && showRecipeContent" :recipe-id="recipeId" show-always />
+                <RecipeRating
+                  :class="isOwnGroup ? 'ml-auto' : 'ml-auto pb-2'"
+                  :value="rating"
+                  :recipe-id="recipeId"
+                  :slug="slug"
+                  :small="true"
+                />
+                <v-spacer></v-spacer>
+
+                <!-- If we're not logged-in, no items display, so we hide this menu -->
+                <!-- We also add padding to the v-rating above to compensate -->
+                <RecipeContextMenu
+                  v-if="isOwnGroup && showRecipeContent"
+                  :slug="slug"
+                  :menu-icon="$globals.icons.dotsHorizontal"
+                  :name="name"
+                  :recipe-id="recipeId"
+                  :use-items="{
+                    delete: false,
+                    edit: true,
+                    download: true,
+                    mealplanner: true,
+                    shoppingList: true,
+                    print: false,
+                    printPreferences: false,
+                    share: true,
+                  }"
+                  @deleted="$emit('delete', slug)"
+                />
+              </slot>
+            </div>
+          </v-list-item-content>
+        </v-list-item>
+        <slot />
+      </v-card>
+    </v-expand-transition>
+  </div>
 </template>
 
 <script lang="ts">
@@ -135,9 +137,13 @@ export default defineComponent({
       type: Boolean,
       default: false,
     },
-    avatarSize: {
+    height: {
+      type: [Number, String],
+      default: 150,
+    },
+    imageHeight: {
       type: [Number, String],
-      default: 125,
+      default: "fill-height",
     },
   },
   setup(props) {

diff --git a/frontend/components/Domain/Recipe/RecipeCardSection.vue b/frontend/components/Domain/Recipe/RecipeCardSection.vue
@@ -104,7 +104,6 @@
               :image="recipe.image"
               :tags="recipe.tags"
               :recipe-id="recipe.id"
-              avatar-size="fill-height"
             />
           </v-lazy>
         </v-col>

diff --git a/frontend/components/Domain/ShoppingList/ShoppingListItemEditor.vue b/frontend/components/Domain/ShoppingList/ShoppingListItemEditor.vue
@@ -3,14 +3,9 @@
     <v-card outlined>
       <v-card-text class="pb-3 pt-1">
         <div v-if="listItem.isFood" class="d-md-flex align-center mb-2" style="gap: 20px">
-          <InputLabelType
-            v-model="listItem.food"
-            :items="foods"
-            :item-id.sync="listItem.foodId"
-            :label="$t('shopping-list.food')"
-            :icon="$globals.icons.foods"
-            @create="createAssignFood"
-          />
+          <div>
+            <InputQuantity v-model="listItem.quantity" />
+          </div>
           <InputLabelType
             v-model="listItem.unit"
             :items="units"
@@ -19,8 +14,20 @@
             :icon="$globals.icons.units"
             @create="createAssignUnit"
           />
+          <InputLabelType
+            v-model="listItem.food"
+            :items="foods"
+            :item-id.sync="listItem.foodId"
+            :label="$t('shopping-list.food')"
+            :icon="$globals.icons.foods"
+            @create="createAssignFood"
+          />
+
         </div>
         <div class="d-md-flex align-center" style="gap: 20px">
+          <div v-if="!listItem.isFood">
+              <InputQuantity v-model="listItem.quantity" />
+            </div>
           <v-textarea
             v-model="listItem.note"
             hide-details
@@ -32,9 +39,7 @@
         </div>
         <div class="d-flex flex-wrap align-end" style="gap: 20px">
           <div class="d-flex align-end">
-            <div>
-              <InputQuantity v-model="listItem.quantity" />
-            </div>
+
             <div style="max-width: 300px" class="mt-3 mr-auto">
               <InputLabelType
                 v-model="listItem.label"