Feature/restore-recipe-functionality (#810)

* feat(frontend): ✨ add back support for assets

* feat(backend): ✨ add back support for assets

* feat(frontend): ✨ add support for recipe tools

* feat(backend): ✨ add support for recipe tools

* feat(frontend): ✨ add onHand support for recipe toosl

* feat(backend): ✨ add onHand support for backend

* refactor(frontend): ♻️ move items to recipe folder and break apart types

* feat(frontend): ✨ add support for recipe comments

* feat(backend): ✨ Add support for recipe comments

* fix(backend): 💥 disable comments import

* fix(frontend): 🐛 fix rendering issue with titles when moving steps

* add tools to changelog

* fix type errors

Co-authored-by: hay-kot <hay-kot@pm.me>

frontend/api/class-interfaces/recipes/index.ts

@@ -0,0 +1 @@
+export { RecipeAPI } from "./recipe";

frontend/api/class-interfaces/recipes/recipe-comments.ts

@@ -0,0 +1,19 @@
+import { RecipeComment, RecipeCommentCreate } from "./types";
+import { BaseCRUDAPI } from "~/api/_base";
+
+const prefix = "/api";
+
+const routes = {
+  comment: `${prefix}/comments`,
+  byRecipe: (id: string) => `${prefix}/recipes/${id}/comments`,
+  commentsId: (id: string) => `${prefix}/comments/${id}`,
+};
+
+export class CommentsApi extends BaseCRUDAPI<RecipeComment, RecipeCommentCreate> {
+  baseRoute: string = routes.comment;
+  itemRoute = routes.commentsId;
+
+  async byRecipe(slug: string) {
+    return await this.requests.get<RecipeComment[]>(routes.byRecipe(slug));
+  }
+}

frontend/api/class-interfaces/recipes/recipe.ts

@@ -1,7 +1,9 @@
-import { BaseCRUDAPI } from "../_base";
-import { Category } from "./categories";
-import { Tag } from "./tags";
+import { CreateAsset, ParsedIngredient, Parser, RecipeZipToken, BulkCreatePayload } from "./types";
+import { CommentsApi } from "./recipe-comments";
+import { BaseCRUDAPI } from "~/api/_base";
+
 import { Recipe, CreateRecipe } from "~/types/api-types/recipe";
+import { ApiRequestInstance } from "~/types/api";
 
 const prefix = "/api";
 
@@ -26,68 +28,35 @@ const routes = {
   recipesSlugCommentsId: (slug: string, id: number) => `${prefix}/recipes/${slug}/comments/${id}`,
 };
 
-export type Parser = "nlp" | "brute";
-
-export interface Confidence {
-  average?: number;
-  comment?: number;
-  name?: number;
-  unit?: number;
-  quantity?: number;
-  food?: number;
-}
-
-export interface Unit {
-  name: string;
-  description: string;
-  fraction: boolean;
-  abbreviation: string;
-}
-
-export interface Food {
-  name: string;
-  description?: string;
-}
-
-export interface Ingredient {
-  referenceId: string;
-  title: string;
-  note: string;
-  unit: Unit | null;
-  food: Food | null;
-  disableAmount: boolean;
-  quantity: number;
-}
-
-export interface ParsedIngredient {
-  confidence: Confidence;
-  ingredient: Ingredient;
-}
-
-export interface BulkCreateRecipe {
-  url: string;
-  categories: Category[];
-  tags: Tag[];
-}
-
-export interface BulkCreatePayload {
-  imports: BulkCreateRecipe[];
-}
-
-export interface RecipeZipToken {
-  token: string;
-}
-
 export class RecipeAPI extends BaseCRUDAPI<Recipe, CreateRecipe> {
   baseRoute: string = routes.recipesBase;
   itemRoute = routes.recipesRecipeSlug;
 
+  public comments: CommentsApi;
+
+  constructor(requests: ApiRequestInstance) {
+    super(requests);
+
+    this.comments = new CommentsApi(requests);
+  }
+
   async getAllByCategory(categories: string[]) {
     return await this.requests.get<Recipe[]>(routes.recipesCategory, {
       categories,
     });
   }
 
+  async createAsset(recipeSlug: string, payload: CreateAsset) {
+    const formData = new FormData();
+    // @ts-ignore
+    formData.append("file", payload.file);
+    formData.append("name", payload.name);
+    formData.append("extension", payload.extension);
+    formData.append("icon", payload.icon);
+
+    return await this.requests.post(routes.recipesRecipeSlugAssets(recipeSlug), formData);
+  }
+
   updateImage(slug: string, fileObject: File) {
     const formData = new FormData();
     formData.append("image", fileObject);
@@ -113,8 +82,6 @@ export class RecipeAPI extends BaseCRUDAPI<Recipe, CreateRecipe> {
     return await this.requests.post(routes.recipesCreateUrlBulk, payload);
   }
 
-  // Recipe Comments
-
   // Methods to Generate reference urls for assets/images *
   recipeImage(recipeSlug: string, version = null, key = null) {
     return `/api/media/recipes/${recipeSlug}/images/original.webp?&rnd=${key}&version=${version}`;
@@ -132,22 +99,6 @@ export class RecipeAPI extends BaseCRUDAPI<Recipe, CreateRecipe> {
     return `/api/media/recipes/${recipeSlug}/assets/${assetName}`;
   }
 
-  async createComment(slug: string, payload: Object) {
-    return await this.requests.post(routes.recipesSlugComments(slug), payload);
-  }
-
-  /** Update comment in the Database
-   */
-  async updateComment(slug: string, id: number, payload: Object) {
-    return await this.requests.put(routes.recipesSlugCommentsId(slug, id), payload);
-  }
-
-  /** Delete comment from the Database
-   */
-  async deleteComment(slug: string, id: number) {
-    return await this.requests.delete(routes.recipesSlugCommentsId(slug, id));
-  }
-
   async parseIngredients(parser: Parser, ingredients: Array<string>) {
     parser = parser || "nlp";
     return await this.requests.post<ParsedIngredient[]>(routes.recipesParseIngredients, { parser, ingredients });

frontend/api/class-interfaces/recipes/types.ts

@@ -0,0 +1,83 @@
+import { Category } from "../categories";
+import { Tag } from "../tags";
+
+export type Parser = "nlp" | "brute";
+
+export interface Confidence {
+  average?: number;
+  comment?: number;
+  name?: number;
+  unit?: number;
+  quantity?: number;
+  food?: number;
+}
+
+export interface Unit {
+  name: string;
+  description: string;
+  fraction: boolean;
+  abbreviation: string;
+}
+
+export interface Food {
+  name: string;
+  description?: string;
+}
+
+export interface Ingredient {
+  referenceId: string;
+  title: string;
+  note: string;
+  unit: Unit | null;
+  food: Food | null;
+  disableAmount: boolean;
+  quantity: number;
+}
+
+export interface ParsedIngredient {
+  confidence: Confidence;
+  ingredient: Ingredient;
+}
+
+export interface BulkCreateRecipe {
+  url: string;
+  categories: Category[];
+  tags: Tag[];
+}
+
+export interface BulkCreatePayload {
+  imports: BulkCreateRecipe[];
+}
+
+export interface RecipeZipToken {
+  token: string;
+}
+
+export interface CreateAsset {
+  name: string;
+  icon: string;
+  extension: string;
+  file?: File;
+}
+
+export interface RecipeCommentCreate {
+  recipeId: number;
+  text: string;
+}
+
+export interface RecipeCommentUpdate extends RecipeCommentCreate {
+  id: string;
+}
+
+interface RecipeCommentUser {
+  id: string;
+  username: string;
+  admin: boolean;
+}
+
+export interface RecipeComment extends RecipeCommentUpdate {
+  createdAt: any;
+  updatedAt: any;
+  userId: number;
+  user: RecipeCommentUser;
+}

frontend/api/class-interfaces/tools.ts

@@ -0,0 +1,22 @@
+import { BaseCRUDAPI } from "../_base";
+
+const prefix = "/api";
+
+export interface CreateTool {
+  name: string;
+  onHand: boolean;
+}
+
+export interface Tool extends CreateTool {
+  id: number;
+}
+
+const routes = {
+  tools: `${prefix}/tools`,
+  toolsId: (id: string) => `${prefix}/tools/${id}`,
+};
+
+export class ToolsApi extends BaseCRUDAPI<Tool, CreateTool> {
+  baseRoute: string = routes.tools;
+  itemRoute = routes.toolsId;
+}