From 3807778e2fbd1bbb9844f0a24b01699c745fe99e Mon Sep 17 00:00:00 2001
From: Michael Genson <71845777+michael-genson@users.noreply.github.com>
Date: Wed, 1 May 2024 02:20:52 -0500
Subject: [PATCH] feat: Recipe Actions (#3448)
Co-authored-by: boc-the-git <3479092+boc-the-git@users.noreply.github.com>
Co-authored-by: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com>
---
...0_7788478a0338_add_group_recipe_actions.py | 52 ++++
.../documentation/getting-started/features.md | 54 +++-
docs/docs/overrides/api.html | 2 +-
.../Domain/Recipe/RecipeActionMenu.vue | 1 +
.../Domain/Recipe/RecipeContextMenu.vue | 40 ++-
.../composables/use-group-recipe-actions.ts | 98 +++++++
frontend/lang/messages/en-US.json | 11 +-
frontend/lib/api/client-user.ts | 3 +
frontend/lib/api/types/group.ts | 21 ++
frontend/lib/api/user/group-recipe-actions.ts | 14 +
frontend/pages/group/data.vue | 14 +-
frontend/pages/group/data/recipe-actions.vue | 265 ++++++++++++++++++
mealie/db/models/group/__init__.py | 1 +
mealie/db/models/group/group.py | 3 +
mealie/db/models/group/recipe_action.py | 25 ++
mealie/repos/repository_factory.py | 6 +
mealie/routes/groups/__init__.py | 2 +
.../groups/controller_group_recipe_actions.py | 55 ++++
mealie/schema/group/__init__.py | 64 ++++-
mealie/schema/group/group_recipe_action.py | 32 +++
.../test_group_recipe_actions.py | 100 +++++++
tests/utils/api_routes/__init__.py | 7 +
22 files changed, 860 insertions(+), 10 deletions(-)
create mode 100644 alembic/versions/2024-04-07-01.05.20_7788478a0338_add_group_recipe_actions.py
create mode 100644 frontend/composables/use-group-recipe-actions.ts
create mode 100644 frontend/lib/api/user/group-recipe-actions.ts
create mode 100644 frontend/pages/group/data/recipe-actions.vue
create mode 100644 mealie/db/models/group/recipe_action.py
create mode 100644 mealie/routes/groups/controller_group_recipe_actions.py
create mode 100644 mealie/schema/group/group_recipe_action.py
create mode 100644 tests/integration_tests/user_group_tests/test_group_recipe_actions.py
diff --git a/alembic/versions/2024-04-07-01.05.20_7788478a0338_add_group_recipe_actions.py b/alembic/versions/2024-04-07-01.05.20_7788478a0338_add_group_recipe_actions.py
new file mode 100644
index 000000000..1a7162c39
--- /dev/null
+++ b/alembic/versions/2024-04-07-01.05.20_7788478a0338_add_group_recipe_actions.py
@@ -0,0 +1,52 @@
+"""add group recipe actions
+
+Revision ID: 7788478a0338
+Revises: d7c6efd2de42
+Create Date: 2024-04-07 01:05:20.816270
+
+"""
+
+import sqlalchemy as sa
+
+import mealie.db.migration_types
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "7788478a0338"
+down_revision = "d7c6efd2de42"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.create_table(
+ "recipe_actions",
+ sa.Column("id", mealie.db.migration_types.GUID(), nullable=False),
+ sa.Column("group_id", mealie.db.migration_types.GUID(), nullable=False),
+ sa.Column("action_type", sa.String(), nullable=False),
+ sa.Column("title", sa.String(), nullable=False),
+ sa.Column("url", sa.String(), nullable=False),
+ sa.Column("created_at", sa.DateTime(), nullable=True),
+ sa.Column("update_at", sa.DateTime(), nullable=True),
+ sa.ForeignKeyConstraint(
+ ["group_id"],
+ ["groups.id"],
+ ),
+ sa.PrimaryKeyConstraint("id"),
+ )
+ op.create_index(op.f("ix_recipe_actions_action_type"), "recipe_actions", ["action_type"], unique=False)
+ op.create_index(op.f("ix_recipe_actions_created_at"), "recipe_actions", ["created_at"], unique=False)
+ op.create_index(op.f("ix_recipe_actions_group_id"), "recipe_actions", ["group_id"], unique=False)
+ op.create_index(op.f("ix_recipe_actions_title"), "recipe_actions", ["title"], unique=False)
+ # ### end Alembic commands ###
+
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.drop_index(op.f("ix_recipe_actions_title"), table_name="recipe_actions")
+ op.drop_index(op.f("ix_recipe_actions_group_id"), table_name="recipe_actions")
+ op.drop_index(op.f("ix_recipe_actions_created_at"), table_name="recipe_actions")
+ op.drop_index(op.f("ix_recipe_actions_action_type"), table_name="recipe_actions")
+ op.drop_table("recipe_actions")
+ # ### end Alembic commands ###
diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md
index 463bf18ac..75c4b590a 100644
--- a/docs/docs/documentation/getting-started/features.md
+++ b/docs/docs/documentation/getting-started/features.md
@@ -81,12 +81,60 @@ The meal planner has the concept of plan rules. These offer a flexible way to us
The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list or link a recipe and all of it's ingredients to track meals during the week.
-!!! warning
- At this time there isn't a tight integration between meal-plans and shopping lists; however, it's something we have planned for the future.
-
[Shopping List Demo](https://demo.mealie.io/shopping-lists){ .md-button .md-button--primary }
+## Integrations
+
+Mealie is designed to integrate with many different external services. There are several ways you can integrate with Mealie to achieve custom IoT automations, data synchronization, and anything else you can think of. [You can work directly with Mealie through the API](./api-usage.md), or leverage other services to make seamless integrations.
+
+### Notifiers
+
+Notifiers are event-driven notifications sent when specific actions are performed within Mealie. Some actions include:
+- creating a recipe
+- adding items to a shopping list
+- creating a new mealplan
+
+Notifiers use the [Apprise library](https://github.com/caronc/apprise/wiki), which integrates with a large number of notification services. In addition, certain custom notifiers send basic event data to the consumer (e.g. the `id` of the resource). These include:
+- `form` and `forms`
+- `json` and `jsons`
+- `xml` and `xmls`
+
+[Notifiers Demo](https://demo.mealie.io/group/notifiers){ .md-button .md-button--primary }
+
+### Webhooks
+
+Unlike notifiers, which are event-driven notifications, Webhooks allow you to send scheduled notifications to your desired endpoint. Webhooks are sent on the day of a scheduled mealplan, at the specified time, and contain the mealplan data in the request.
+
+[Webhooks Demo](https://demo.mealie.io/group/webhooks){ .md-button .md-button--primary }
+
+### Recipe Actions
+
+Recipe Actions are custom actions you can add to all recipes in Mealie. This is a great way to add custom integrations that are fired manually. There are two types of recipe actions:
+1. link - these actions will take you directly to an external page
+2. post - these actions will send a `POST` request to the specified URL, with the recipe JSON in the request body. These can be used, for instance, to manually trigger a webhook in Home Assistant
+
+Recipe Action URLs can include merge fields to inject the current recipe's data. For instance, you can use the following URL to include a Google search with the recipe's slug:
+```
+https://www.google.com/search?q=${slug}
+```
+
+When the action is clicked on, the `${slug}` field is replaced with the recipe's slug value. So, for example, it might take you to this URL on one of your recipes:
+```
+https://www.google.com/search?q=pasta-fagioli
+```
+
+A common use case for "link" recipe actions is to integrate with the Bring! shopping list. Simply add a Recipe Action with the following URL:
+```
+https://api.getbring.com/rest/bringrecipes/deeplink?url=${url}&source=web
+```
+
+Below is a list of all valid merge fields:
+- ${id}
+- ${slug}
+- ${url}
+
+To add, modify, or delete Recipe Actions, visit the Data Management page (more on that below).
## Data Management
diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html
index 1a9cf805c..ec16cb46c 100644
--- a/docs/docs/overrides/api.html
+++ b/docs/docs/overrides/api.html
@@ -14,7 +14,7 @@
diff --git a/frontend/components/Domain/Recipe/RecipeActionMenu.vue b/frontend/components/Domain/Recipe/RecipeActionMenu.vue
index 694a23d36..adb0b0b09 100644
--- a/frontend/components/Domain/Recipe/RecipeActionMenu.vue
+++ b/frontend/components/Domain/Recipe/RecipeActionMenu.vue
@@ -70,6 +70,7 @@
print: true,
printPreferences: true,
share: loggedIn,
+ recipeActions: true,
}"
@print="$emit('print')"
/>
diff --git a/frontend/components/Domain/Recipe/RecipeContextMenu.vue b/frontend/components/Domain/Recipe/RecipeContextMenu.vue
index dd96bb137..3e1e27edc 100644
--- a/frontend/components/Domain/Recipe/RecipeContextMenu.vue
+++ b/frontend/components/Domain/Recipe/RecipeContextMenu.vue
@@ -105,6 +105,26 @@
{{ item.title }}
+
+
+
+
+ {{ $tc("recipe.recipe-actions") }}
+
+
+
+
+ {{ action.title }}
+
+
+
+
+
@@ -117,11 +137,12 @@ import RecipeDialogPrintPreferences from "./RecipeDialogPrintPreferences.vue";
import RecipeDialogShare from "./RecipeDialogShare.vue";
import { useLoggedInState } from "~/composables/use-logged-in-state";
import { useUserApi } from "~/composables/api";
+import { useGroupRecipeActions } from "~/composables/use-group-recipe-actions";
import { useGroupSelf } from "~/composables/use-groups";
import { alert } from "~/composables/use-toast";
import { usePlanTypeOptions } from "~/composables/use-group-mealplan";
import { Recipe } from "~/lib/api/types/recipe";
-import { ShoppingListSummary } from "~/lib/api/types/group";
+import { GroupRecipeActionOut, ShoppingListSummary } from "~/lib/api/types/group";
import { PlanEntryType } from "~/lib/api/types/meal-plan";
import { useAxiosDownloader } from "~/composables/api/use-axios-download";
@@ -134,6 +155,7 @@ export interface ContextMenuIncludes {
print: boolean;
printPreferences: boolean;
share: boolean;
+ recipeActions: boolean;
}
export interface ContextMenuItem {
@@ -163,6 +185,7 @@ export default defineComponent({
print: true,
printPreferences: true,
share: true,
+ recipeActions: true,
}),
},
// Append items are added at the end of the useItems list
@@ -347,6 +370,19 @@ export default defineComponent({
}
const router = useRouter();
+ const groupRecipeActionsStore = useGroupRecipeActions();
+
+ async function executeRecipeAction(action: GroupRecipeActionOut) {
+ const response = await groupRecipeActionsStore.execute(action, props.recipe);
+
+ if (action.actionType === "post") {
+ if (!response || (response.status >= 200 && response.status < 300)) {
+ alert.success(i18n.tc("events.message-sent"));
+ } else {
+ alert.error(i18n.tc("events.something-went-wrong"));
+ }
+ }
+ }
async function deleteRecipe() {
await api.recipes.deleteOne(props.slug);
@@ -437,6 +473,8 @@ export default defineComponent({
...toRefs(state),
recipeRef,
recipeRefWithScale,
+ executeRecipeAction,
+ recipeActions: groupRecipeActionsStore.recipeActions,
shoppingLists,
duplicateRecipe,
contextMenuEventHandler,
diff --git a/frontend/composables/use-group-recipe-actions.ts b/frontend/composables/use-group-recipe-actions.ts
new file mode 100644
index 000000000..6605baaf2
--- /dev/null
+++ b/frontend/composables/use-group-recipe-actions.ts
@@ -0,0 +1,98 @@
+import { computed, reactive, ref } from "@nuxtjs/composition-api";
+import { useStoreActions } from "./partials/use-actions-factory";
+import { useUserApi } from "~/composables/api";
+import { GroupRecipeActionOut, RecipeActionType } from "~/lib/api/types/group";
+import { Recipe } from "~/lib/api/types/recipe";
+
+const groupRecipeActions = ref(null);
+const loading = ref(false);
+
+export function useGroupRecipeActionData() {
+ const data = reactive({
+ id: "",
+ actionType: "link" as RecipeActionType,
+ title: "",
+ url: "",
+ });
+
+ function reset() {
+ data.id = "";
+ data.actionType = "link";
+ data.title = "";
+ data.url = "";
+ }
+
+ return {
+ data,
+ reset,
+ };
+}
+
+export const useGroupRecipeActions = function (
+ orderBy: string | null = "title",
+ orderDirection: string | null = "asc",
+) {
+ const api = useUserApi();
+
+ async function refreshGroupRecipeActions() {
+ loading.value = true;
+ const { data } = await api.groupRecipeActions.getAll(1, -1, { orderBy, orderDirection });
+ groupRecipeActions.value = data?.items || null;
+ loading.value = false;
+ }
+
+ const recipeActions = computed(() => {
+ return groupRecipeActions.value;
+ });
+
+ function parseRecipeActionUrl(url: string, recipe: Recipe): string {
+ /* eslint-disable no-template-curly-in-string */
+ return url
+ .replace("${url}", window.location.href)
+ .replace("${id}", recipe.id || "")
+ .replace("${slug}", recipe.slug || "")
+ /* eslint-enable no-template-curly-in-string */
+ };
+
+ async function execute(action: GroupRecipeActionOut, recipe: Recipe): Promise {
+ const url = parseRecipeActionUrl(action.url, recipe);
+
+ switch (action.actionType) {
+ case "link":
+ window.open(url, "_blank")?.focus();
+ break;
+ case "post":
+ return await fetch(url, {
+ method: "POST",
+ headers: {
+ // The "text/plain" content type header is used here to skip the CORS preflight request,
+ // since it may fail. This is fine, since we don't care about the response, we just want
+ // the request to get sent.
+ "Content-Type": "text/plain",
+ },
+ body: JSON.stringify(recipe),
+ }).catch((error) => {
+ console.error(error);
+ });
+ default:
+ break;
+ }
+ };
+
+ if (!groupRecipeActions.value && !loading.value) {
+ refreshGroupRecipeActions();
+ };
+
+ const actions = {
+ ...useStoreActions(api.groupRecipeActions, groupRecipeActions, loading),
+ flushStore() {
+ groupRecipeActions.value = [];
+ }
+ }
+
+ return {
+ actions,
+ execute,
+ recipeActions,
+ };
+};
diff --git a/frontend/lang/messages/en-US.json b/frontend/lang/messages/en-US.json
index 8dabe5b82..47c2e41e8 100644
--- a/frontend/lang/messages/en-US.json
+++ b/frontend/lang/messages/en-US.json
@@ -64,6 +64,7 @@
"something-went-wrong": "Something Went Wrong!",
"subscribed-events": "Subscribed Events",
"test-message-sent": "Test Message Sent",
+ "message-sent": "Message Sent",
"new-notification": "New Notification",
"event-notifiers": "Event Notifiers",
"apprise-url-skipped-if-blank": "Apprise URL (skipped if blank)",
@@ -160,6 +161,7 @@
"test": "Test",
"themes": "Themes",
"thursday": "Thursday",
+ "title": "Title",
"token": "Token",
"tuesday": "Tuesday",
"type": "Type",
@@ -582,7 +584,8 @@
"upload-image": "Upload image",
"screen-awake": "Keep Screen Awake",
"remove-image": "Remove image",
- "nextStep": "Next step"
+ "nextStep": "Next step",
+ "recipe-actions": "Recipe Actions"
},
"search": {
"advanced-search": "Advanced Search",
@@ -1001,6 +1004,12 @@
"delete-recipes": "Delete Recipes",
"source-unit-will-be-deleted": "Source Unit will be deleted"
},
+ "recipe-actions": {
+ "recipe-actions-data": "Recipe Actions Data",
+ "new-recipe-action": "New Recipe Action",
+ "edit-recipe-action": "Edit Recipe Action",
+ "action-type": "Action Type"
+ },
"create-alias": "Create Alias",
"manage-aliases": "Manage Aliases",
"seed-data": "Seed Data",
diff --git a/frontend/lib/api/client-user.ts b/frontend/lib/api/client-user.ts
index 6c7e1dd85..cc40f42f3 100644
--- a/frontend/lib/api/client-user.ts
+++ b/frontend/lib/api/client-user.ts
@@ -9,6 +9,7 @@ import { UtilsAPI } from "./user/utils";
import { FoodAPI } from "./user/recipe-foods";
import { UnitAPI } from "./user/recipe-units";
import { CookbookAPI } from "./user/group-cookbooks";
+import { GroupRecipeActionsAPI } from "./user/group-recipe-actions";
import { WebhooksAPI } from "./user/group-webhooks";
import { RegisterAPI } from "./user/user-registration";
import { MealPlanAPI } from "./user/group-mealplan";
@@ -36,6 +37,7 @@ export class UserApiClient {
public foods: FoodAPI;
public units: UnitAPI;
public cookbooks: CookbookAPI;
+ public groupRecipeActions: GroupRecipeActionsAPI;
public groupWebhooks: WebhooksAPI;
public register: RegisterAPI;
public mealplans: MealPlanAPI;
@@ -65,6 +67,7 @@ export class UserApiClient {
this.users = new UserApi(requests);
this.groups = new GroupAPI(requests);
this.cookbooks = new CookbookAPI(requests);
+ this.groupRecipeActions = new GroupRecipeActionsAPI(requests);
this.groupWebhooks = new WebhooksAPI(requests);
this.register = new RegisterAPI(requests);
this.mealplans = new MealPlanAPI(requests);
diff --git a/frontend/lib/api/types/group.ts b/frontend/lib/api/types/group.ts
index f9bb8c9ec..a824019ca 100644
--- a/frontend/lib/api/types/group.ts
+++ b/frontend/lib/api/types/group.ts
@@ -5,6 +5,9 @@
/* Do not modify it by hand - just update the pydantic models and then re-run the script
*/
+export type RecipeActionType =
+ | "link"
+ | "post";
export type WebhookType = "mealplan";
export type SupportedMigrations =
| "nextcloud"
@@ -26,6 +29,11 @@ export interface CreateGroupPreferences {
recipeDisableAmount?: boolean;
groupId: string;
}
+export interface CreateGroupRecipeAction {
+ actionType: RecipeActionType;
+ title: string;
+ url: string;
+}
export interface CreateInviteToken {
uses: number;
}
@@ -191,6 +199,13 @@ export interface GroupEventNotifierUpdate {
options?: GroupEventNotifierOptions;
id: string;
}
+export interface GroupRecipeActionOut {
+ actionType: RecipeActionType;
+ title: string;
+ url: string;
+ groupId: string;
+ id: string;
+}
export interface GroupStatistics {
totalRecipes: number;
totalUsers: number;
@@ -230,6 +245,12 @@ export interface ReadWebhook {
groupId: string;
id: string;
}
+export interface SaveGroupRecipeAction {
+ actionType: RecipeActionType;
+ title: string;
+ url: string;
+ groupId: string;
+}
export interface SaveInviteToken {
usesLeft: number;
groupId: string;
diff --git a/frontend/lib/api/user/group-recipe-actions.ts b/frontend/lib/api/user/group-recipe-actions.ts
new file mode 100644
index 000000000..b1288bf1b
--- /dev/null
+++ b/frontend/lib/api/user/group-recipe-actions.ts
@@ -0,0 +1,14 @@
+import { BaseCRUDAPI } from "../base/base-clients";
+import { CreateGroupRecipeAction, GroupRecipeActionOut } from "~/lib/api/types/group";
+
+const prefix = "/api";
+
+const routes = {
+ groupRecipeActions: `${prefix}/groups/recipe-actions`,
+ groupRecipeActionsId: (id: string | number) => `${prefix}/groups/recipe-actions/${id}`,
+ };
+
+ export class GroupRecipeActionsAPI extends BaseCRUDAPI {
+ baseRoute = routes.groupRecipeActions;
+ itemRoute = routes.groupRecipeActionsId;
+ }
diff --git a/frontend/pages/group/data.vue b/frontend/pages/group/data.vue
index f48b59a9c..2dfce3531 100644
--- a/frontend/pages/group/data.vue
+++ b/frontend/pages/group/data.vue
@@ -41,6 +41,7 @@ export default defineComponent({
const { i18n } = useContext();
const buttonLookup: { [key: string]: string } = {
recipes: i18n.tc("general.recipes"),
+ recipeActions: i18n.tc("recipe.recipe-actions"),
foods: i18n.tc("general.foods"),
units: i18n.tc("general.units"),
labels: i18n.tc("data-pages.labels.labels"),
@@ -56,6 +57,11 @@ export default defineComponent({
text: i18n.t("general.recipes"),
value: "new",
to: "/group/data/recipes",
+ },
+ {
+ text: i18n.t("recipe.recipe-actions"),
+ value: "new",
+ to: "/group/data/recipe-actions",
divider: true,
},
{
@@ -92,7 +98,13 @@ export default defineComponent({
]);
const buttonText = computed(() => {
- const last = route.value.path.split("/").pop();
+ const last = route.value.path
+ .split("/")
+ .pop()
+ // convert hypenated-values to camelCase
+ ?.replace(/-([a-z])/g, function (g) {
+ return g[1].toUpperCase();
+ })
if (last) {
return buttonLookup[last];
diff --git a/frontend/pages/group/data/recipe-actions.vue b/frontend/pages/group/data/recipe-actions.vue
new file mode 100644
index 000000000..6389f9e28
--- /dev/null
+++ b/frontend/pages/group/data/recipe-actions.vue
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ $t("general.confirm-delete-generic") }}
+ {{ deleteTarget.title }}
+
+
+
+
+
+
+ {{ $t('general.confirm-delete-generic-items') }}
+
+
+
+
+
+ {{ item.name }}
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ $t("general.create") }}
+
+
+
+ {{ item.onHand ? $globals.icons.check : $globals.icons.close }}
+
+
+
+