#141 task template stages visibility successfully toggles.

packages/api/src/models/battery.ts

@@ -28,6 +28,7 @@ const batteryStageSchema = new Schema<IBatteryStage>({
   type: { type: String, required: true },
   stageLabel: String,
   options: optionGroupSchema,
+  isVisibleToNonAdmins: { type: Boolean, default: true },
 });
 
 const optArray = optionGroupSchema.path<Schema.Types.DocumentArray>("options");

packages/api/src/routes/admin.route.ts

@@ -42,4 +42,16 @@ router.delete(
   route((req) => adminService.removeUserAsAdmin(req.params.id))
 );
 
+router.put(
+  "/battery/:id/stage/:stageId/visibility/:status",
+  isAdmin,
+  route((req) =>
+    adminService.updateStageVisibility(
+      req.params.id,
+      req.params.stageId,
+      req.params.status
+    )
+  )
+);
+
 export default router;

packages/api/src/services/admin.service.ts

@@ -10,6 +10,7 @@ import type {
   IBattery,
   IUser,
 } from "@seitz/shared";
+import { parseVisibility } from "@/util/validation.utils";
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
@@ -87,6 +88,29 @@ export const removeUserAsAdmin = async (userId: string): APIResponse<void> => {
   return [200];
 };
 
+export const updateStageVisibility = async (
+  batteryId: string,
+  stageId: string,
+  visibility: string
+): APIResponse<IBattery> => {
+  const isVisibleToNonAdmins = parseVisibility(visibility);
+
+  const updatedBattery = await Battery.findOneAndUpdate(
+    { _id: batteryId, "stages._id": stageId },
+    { $set: { "stages.$.isVisibleToNonAdmins": isVisibleToNonAdmins } },
+    { new: true }
+  );
+
+  if (!updatedBattery) {
+    throw new HttpError(
+      404,
+      `Battery ${batteryId} or Stage ${stageId} not found.`
+    );
+  }
+
+  return [200, updatedBattery];
+};
+
 function parseOptions(s: any): CreateOption[] {
   return Object.entries(s).reduce((acc: CreateOption[], item: any) => {
     const optionName = item[0];

packages/api/src/types/errors.ts

@@ -6,3 +6,9 @@ export default class HttpError extends Error {
     this.status = status;
   }
 }
+
+export class VisibilityError extends HttpError {
+  constructor(message: string) {
+    super(403, message);
+  }
+}

packages/api/src/util/validation.utils.ts

@@ -0,0 +1,23 @@
+import { VisibilityError } from "@/types/errors";
+
+export enum Visibility {
+  ON = "on",
+  OFF = "off",
+}
+
+export const parseVisibility = (visibility: string): boolean => {
+  try {
+    if (!Object.values(Visibility).includes(visibility as Visibility)) {
+      throw new VisibilityError(
+        `Invalid visibility value: '${visibility}'. Must be either '${Visibility.ON}' or '${Visibility.OFF}'`
+      );
+    }
+    return visibility === Visibility.ON;
+  } catch (e) {
+    // Log the error for monitoring but default to OFF for safety - debugging statement :/
+    console.warn(
+      `Invalid visibility value received: ${visibility}. Defaulting to OFF`
+    );
+    return false;
+  }
+};

packages/shared/types/models/battery.ts

@@ -53,6 +53,7 @@ export interface CreateBatteryStage {
   type: string;
   stageLabel: string;
   options: CreateOptionGroup;
+  isVisibleToNonAdmins: boolean;
 }
 
 export interface IBatteryStage extends Required<CreateBatteryStage> {