add: tutorialProgress

Author: Thiemann96

models/tutorialProgress.js

@@ -0,0 +1,70 @@
+// jshint esversion: 6
+// jshint node: true
+"use strict";
+
+const mongoose = require("mongoose");
+
+const QuestionProgressSchema = new mongoose.Schema(
+  {
+    answered: {
+      type: Boolean,
+      default: false,
+    },
+    correct: {
+      type: Boolean,
+      default: false,
+    },
+    answer: {
+      type: mongoose.Schema.Types.Mixed,
+    },
+  },
+  { _id: false }
+);
+
+const StepProgressSchema = new mongoose.Schema(
+  {
+    seen: {
+      type: Boolean,
+      default: false,
+    },
+
+    questions: {
+      type: Map,
+      of: QuestionProgressSchema,
+      default: {},
+    },
+  },
+  { _id: false }
+);
+
+const TutorialProgressSchema = new mongoose.Schema(
+  {
+    user: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      required: true,
+      index: true,
+    },
+
+    tutorial: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Tutorial",
+      required: true,
+      index: true,
+    },
+
+    steps: {
+      type: Map,
+      of: StepProgressSchema,
+      default: {},
+    },
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// 🔐 Ein User darf pro Tutorial nur EIN Progress-Dokument haben
+TutorialProgressSchema.index({ user: 1, tutorial: 1 }, { unique: true });
+
+module.exports = mongoose.model("TutorialProgress", TutorialProgressSchema);

routes/tutorial/index.js

@@ -2,41 +2,78 @@
 // jshint node: true
 "use strict";
 
-var express = require("express");
-var TutorialRouter = express.Router();
+const express = require("express");
+const TutorialRouter = express.Router();
 
 const { userAuthorization } = require("../../helper/userAuthorization");
 const { upload } = require("../../helper/imageUpload");
 
-TutorialRouter.route("/").post(
-  userAuthorization,
-  upload.any(),
-  require("./postTutorial").postTutorial
-);
+// Tutorial CRUD
+const { postTutorial } = require("./postTutorial");
+const { putTutorial } = require("./putTutorial");
+const { deleteTutorial } = require("./deleteTutorial");
+const { getTutorial } = require("./getTutorial");
+const { getTutorials } = require("./getTutorials");
+const { getAllTutorials } = require("./getAllTutorials");
+const { getUserTutorials } = require("./getUserTutorials");
+
+// Tutorial Progress
+const { startTutorial } = require("./tutorialProgress/startTutorial");
+const { markStepSeen } = require("./tutorialProgress/markStepSeen");
+const { answerQuestion } = require("./tutorialProgress/answerQuestion");
+const { getProgress } = require("./tutorialProgress/getProgress");
+const { deleteProgress } = require("./tutorialProgress/deleteProgress");
+const { getAllProgress } = require("./tutorialProgress/getAllProgress");
+
+/* ---------- LIST ROUTES ---------- */
+
+TutorialRouter.get("/", getTutorials);
+TutorialRouter.get("/getAllTutorials", userAuthorization, getAllTutorials);
+TutorialRouter.get("/getUserTutorials", userAuthorization, getUserTutorials);
+
+/* ---------- PROGRESS ROUTES (FIRST!) ---------- */
+
+// 🔥 alle Progresse des Users
+TutorialRouter.get("/progress", userAuthorization, getAllProgress);
 
-TutorialRouter.route("/:tutorialId").put(
+// 🔥 Progress eines Tutorials
+TutorialRouter.get("/:tutorialId/progress", userAuthorization, getProgress);
+
+TutorialRouter.post(
+  "/:tutorialId/steps/:stepId/seen",
   userAuthorization,
-  upload.any(),
-  require("./putTutorial").putTutorial
+  markStepSeen
 );
 
-TutorialRouter.route("/:tutorialId").delete(
+TutorialRouter.post(
+  "/:tutorialId/steps/:stepId/questions/answer",
   userAuthorization,
-  require("./deleteTutorial").deleteTutorial
+  answerQuestion
 );
 
-TutorialRouter.route("/").get(require("./getTutorials").getTutorials);
+TutorialRouter.post("/:tutorialId/start", userAuthorization, startTutorial);
 
-TutorialRouter.route("/getAllTutorials").get(
+TutorialRouter.delete(
+  "/:tutorialId/progress",
   userAuthorization,
-  require("./getAllTutorials").getAllTutorials
+  deleteProgress
 );
 
-TutorialRouter.route("/getUserTutorials").get(
+/* ---------- CRUD ROUTES ---------- */
+
+TutorialRouter.post("/", userAuthorization, upload.any(), postTutorial);
+
+TutorialRouter.put(
+  "/:tutorialId",
   userAuthorization,
-  require("./getUserTutorials").getUserTutorials
+  upload.any(),
+  putTutorial
 );
 
-TutorialRouter.route("/:tutorialId").get(require("./getTutorial").getTutorial);
+TutorialRouter.delete("/:tutorialId", userAuthorization, deleteTutorial);
+
+/* ---------- LAST: SINGLE TUTORIAL ---------- */
+
+TutorialRouter.get("/:tutorialId", getTutorial);
 
 module.exports = TutorialRouter;

routes/tutorial/tutorialProgress/answerQuestion.js

@@ -0,0 +1,41 @@
+// jshint esversion: 8
+// jshint node: true
+"use strict";
+
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+/**
+ * @api {post} /tutorial/:tutorialId/steps/:stepId/questions/:questionId/answer
+ * @apiName answerQuestion
+ * @apiDescription Stores the user's answer for a question.
+ * @apiGroup Tutorial
+ */
+const answerQuestion = async function (req, res) {
+  try {
+    const { tutorialId, stepId } = req.params;
+    const userId = req.user._id;
+    const { correct, questionId } = req.body;
+    await TutorialProgress.findOneAndUpdate(
+      { user: userId, tutorial: tutorialId },
+      {
+        $set: {
+          [`steps.${stepId}.questions.${questionId}`]: {
+            answered: true,
+            correct: !!correct,
+          },
+        },
+      },
+      { upsert: false }
+    );
+
+    return res.status(200).send({
+      message: "Question answered.",
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = {
+  answerQuestion,
+};

routes/tutorial/tutorialProgress/deleteProgress.js

@@ -0,0 +1,25 @@
+"use strict";
+
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+const deleteProgress = async (req, res) => {
+  try {
+    const { tutorialId } = req.params;
+    const userId = req.user._id;
+
+    await TutorialProgress.deleteOne({
+      user: userId,
+      tutorial: tutorialId,
+    });
+
+    return res.status(200).send({
+      message: "Tutorial progress reset.",
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = {
+  deleteProgress,
+};

routes/tutorial/tutorialProgress/getAllProgress.js

@@ -0,0 +1,17 @@
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+const getAllProgress = async (req, res) => {
+  try {
+    const userId = req.user._id;
+
+    const progress = await TutorialProgress.find({ user: userId });
+
+    return res.status(200).send({
+      progress,
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = { getAllProgress };

routes/tutorial/tutorialProgress/getProgress.js

@@ -0,0 +1,23 @@
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+const getProgress = async (req, res) => {
+  try {
+    const { tutorialId } = req.params;
+    const userId = req.user._id;
+
+    const progress = await TutorialProgress.findOne({
+      user: userId,
+      tutorial: tutorialId,
+    });
+
+    return res.status(200).send({
+      progress,
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = {
+  getProgress,
+};

routes/tutorial/tutorialProgress/markStepSeen.js

@@ -0,0 +1,38 @@
+// jshint esversion: 8
+// jshint node: true
+"use strict";
+
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+/**
+ * @api {post} /tutorial/:tutorialId/steps/:stepId/seen
+ * @apiName markStepSeen
+ * @apiDescription Marks a tutorial step as seen for the current user.
+ * @apiGroup Tutorial
+ */
+const markStepSeen = async function (req, res) {
+  try {
+    const { tutorialId, stepId } = req.params;
+    const userId = req.user._id;
+
+    await TutorialProgress.findOneAndUpdate(
+      { user: userId, tutorial: tutorialId },
+      {
+        $set: {
+          [`steps.${stepId}.seen`]: true,
+        },
+      },
+      { upsert: false }
+    );
+
+    return res.status(200).send({
+      message: "Step marked as seen.",
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = {
+  markStepSeen,
+};

routes/tutorial/tutorialProgress/startTutorial.js

@@ -0,0 +1,63 @@
+// jshint esversion: 8
+// jshint node: true
+"use strict";
+
+const mongoose = require("mongoose");
+
+const Tutorial = require("../../../models/tutorial");
+const TutorialProgress = require("../../../models/tutorialProgress");
+
+/**
+ * @api {post} /tutorial/:tutorialId/start Start tutorial
+ * @apiName startTutorial
+ * @apiDescription Initializes tutorial progress for the current user.
+ * @apiGroup Tutorial
+ *
+ * @apiParam {ObjectId} tutorialId ID of the tutorial to start
+ *
+ * @apiSuccess (200) {String} message Tutorial started successfully.
+ * @apiSuccess (200) {Object} progress Tutorial progress document
+ *
+ * @apiError (404) Tutorial not found
+ * @apiError (500) Database error
+ */
+const startTutorial = async function (req, res) {
+  try {
+    const tutorialId = req.params.tutorialId;
+    const userId = req.user._id;
+
+    // 🔍 Tutorial existiert?
+    const tutorialExists = await Tutorial.exists({ _id: tutorialId });
+    if (!tutorialExists) {
+      return res.status(404).send({
+        message: "Tutorial not found.",
+      });
+    }
+
+    // 🔁 Progress schon vorhanden?
+    let progress = await TutorialProgress.findOne({
+      user: userId,
+      tutorial: tutorialId,
+    });
+
+    // 🆕 Falls nicht → anlegen
+    if (!progress) {
+      progress = await TutorialProgress.create({
+        user: userId,
+        tutorial: tutorialId,
+        steps: {},
+      });
+    }
+
+    return res.status(200).send({
+      message: "Tutorial started successfully.",
+      progress,
+    });
+  } catch (err) {
+    return res.status(500).send(err);
+  }
+};
+
+module.exports = {
+  startTutorial,
+};

routes/user/index.js

@@ -7,7 +7,8 @@ var UserRouter = express.Router();
 
 const { userAuthorization } = require("../../helper/userAuthorization");
 const { requestPasswordReset, resetPassword } = require("./user/resetPassword");
-const { refresh } = require("./user/refresh");UserRouter.route("/register").post(require("./user/register").register);
+const { refresh } = require("./user/refresh");
+UserRouter.route("/register").post(require("./user/register").register);
 
 UserRouter.route("/login").post(require("./user/nativeLogin").nativeLogin);