Added subscription cancellation API.

Author: shrihari-prakash

src/service/api/user/admin-api/routes.ts

@@ -5,6 +5,7 @@ import { DelegatedAuthFlow } from "../../middleware/authenticate.js";
 import POST_Ban, { POST_BanValidator } from "../shared/ban.post.js";
 import POST_Restrict, { POST_RestrictValidator } from "../shared/restrict.post.js";
 import POST_Subscription, { POST_SubscriptionValidator } from "../shared/subscription.post.js";
+import POST_SubscriptionCancel, { POST_SubscriptionCancelValidator } from "../shared/subscription-cancel.post.js";
 import POST_Access, { POST_AccessValidator } from "../shared/access.post.js";
 import POST_Verify, { POST_VerifyValidator } from "./verify.post.js";
 import POST_Create, { POST_CreateValidator } from "../shared/create.post.js";
@@ -31,6 +32,7 @@ AdminApiRouter.post("/credits", ...DelegatedAuthFlow, POST_CreditsValidator, POS
 AdminApiRouter.post("/restrict", ...DelegatedAuthFlow, POST_RestrictValidator, POST_Restrict);
 AdminApiRouter.post("/verify", ...DelegatedAuthFlow, POST_VerifyValidator, POST_Verify);
 AdminApiRouter.post("/subscription", ...DelegatedAuthFlow, POST_SubscriptionValidator, POST_Subscription);
+AdminApiRouter.post("/subscription-cancel", ...DelegatedAuthFlow, POST_SubscriptionCancelValidator, POST_SubscriptionCancel);
 AdminApiRouter.get("/subscription-tiers", ...DelegatedAuthFlow, GET_SubscriptionTiers);
 AdminApiRouter.post("/create", ...DelegatedAuthFlow, POST_CreateValidator, POST_Create);
 AdminApiRouter.get("/list", ...DelegatedAuthFlow, GET_List);

src/service/api/user/client-api/routes.ts

@@ -5,6 +5,7 @@ import { ClientAuthFlow } from "../../middleware/authenticate.js";
 import POST_Ban, { POST_BanValidator } from "../shared/ban.post.js";
 import POST_Restrict, { POST_RestrictValidator } from "../shared/restrict.post.js";
 import POST_Subscription, { POST_SubscriptionValidator } from "../shared/subscription.post.js";
+import POST_SubscriptionCancel, { POST_SubscriptionCancelValidator } from "../shared/subscription-cancel.post.js";
 import POST_Create, { POST_CreateValidator } from "../shared/create.post.js";
 import POST_Credits, { POST_CreditsValidator } from "../shared/credits.post.js";
 import POST_Access, { POST_AccessValidator } from "../shared/access.post.js";
@@ -28,6 +29,7 @@ ClientApiRouter.post("/ban", ...ClientAuthFlow, POST_BanValidator, POST_Ban);
 ClientApiRouter.post("/credits", ...ClientAuthFlow, POST_CreditsValidator, POST_Credits);
 ClientApiRouter.post("/restrict", ...ClientAuthFlow, POST_RestrictValidator, POST_Restrict);
 ClientApiRouter.post("/subscription", ...ClientAuthFlow, POST_SubscriptionValidator, POST_Subscription);
+ClientApiRouter.post("/subscription-cancel", ...ClientAuthFlow, POST_SubscriptionCancelValidator, POST_SubscriptionCancel);
 ClientApiRouter.get("/block-status", ...ClientAuthFlow, GET_BlockStatusValidator, GET_BlockStatus);
 ClientApiRouter.post("/create", ...ClientAuthFlow, POST_CreateValidator, POST_Create);
 ClientApiRouter.get("/list", ...ClientAuthFlow, GET_List);

src/service/api/user/shared/subscription-cancel.post.ts

@@ -0,0 +1,54 @@
+import { Logger } from "../../../../singleton/logger.js";
+const log = Logger.getLogger().child({ from: "user/shared/subscription-cancel.post" });
+
+import { Request, Response } from "express";
+import moment from "moment";
+import { body } from "express-validator";
+import { isValidObjectId } from "mongoose";
+
+import { errorMessages, statusCodes } from "../../../../utils/http-status.js";
+import { ErrorResponse, SuccessResponse } from "../../../../utils/response.js";
+import UserModel from "../../../../model/mongo/user.js";
+import { hasErrors } from "../../../../utils/api.js";
+import { ScopeManager } from "../../../../singleton/scope-manager.js";
+import { flushUserInfoFromRedis } from "../../../../model/oauth/cache.js";
+
+export const POST_SubscriptionCancelValidator = [
+  body("target").exists().isString().isLength({ max: 64 }).custom(isValidObjectId),
+  body("cancelled").exists().isBoolean(),
+];
+
+const POST_SubscriptionCancel = async (req: Request, res: Response): Promise<void> => {
+  try {
+    if (!ScopeManager.isScopeAllowedForSharedSession("<ENTITY>:profile:subscriptions:write", res)) {
+      return;
+    }
+    if (hasErrors(req, res)) return;
+
+    const target = req.body.target;
+    const cancelled = req.body.cancelled;
+
+    const query: any = {
+      $set: {
+        subscriptionCancelled: cancelled,
+      },
+    };
+
+    if (cancelled === true) {
+      query.$set.subscriptionCancelledAt = moment().toDate();
+      query.$set.isSubscribed = false;
+    } else {
+      query.$set.subscriptionCancelledAt = null;
+    }
+
+    await UserModel.updateOne({ _id: target }, query);
+    res.status(statusCodes.success).json(new SuccessResponse());
+    flushUserInfoFromRedis(target);
+  } catch (err) {
+    log.error(err);
+    res.status(statusCodes.internalError).json(new ErrorResponse(errorMessages.internalError));
+  }
+};
+
+export default POST_SubscriptionCancel;
+

src/service/api/user/shared/subscription.post.ts

@@ -19,8 +19,9 @@ export const POST_SubscriptionValidator = [
   body("state").exists().isBoolean(),
   body("expiry").optional().isISO8601(),
   body("tier").optional().isString().isLength({ max: 128 }),
-  body("subscriptionIdentifier").optional().custom((value) => typeof value === "string" || typeof value === "number"),
-  body("cancelled").optional().isBoolean(),
+  body("subscriptionIdentifier")
+    .optional()
+    .custom((value) => typeof value === "string" || typeof value === "number"),
 ];
 
 const POST_Subscription = async (req: Request, res: Response): Promise<void> => {
@@ -34,8 +35,7 @@ const POST_Subscription = async (req: Request, res: Response): Promise<void> =>
     const tier = req.body.tier;
     const expiry = req.body.expiry;
     const subscriptionIdentifier = req.body.subscriptionIdentifier;
-    const cancelled = req.body.cancelled;
-    
+
     if (state === true && !expiry) {
       const errors = [
         {
@@ -66,23 +66,10 @@ const POST_Subscription = async (req: Request, res: Response): Promise<void> =>
         subscriptionTier: tier || null,
       },
     };
-    if (typeof subscriptionIdentifier !== 'undefined') {
+    if (typeof subscriptionIdentifier !== "undefined") {
       query.$set.subscriptionIdentifier = subscriptionIdentifier;
     }
-    
-    // Handle subscription cancellation
-    if (typeof cancelled !== 'undefined') {
-      query.$set.subscriptionCancelled = cancelled;
-      if (cancelled === true) {
-        query.$set.subscriptionCancelledAt = moment().toDate();
-      } else {
-        query.$set.subscriptionCancelledAt = null;
-      }
-    }
-    if (cancelled) {
-      query.$set.isSubscribed = false;
-      query.$set.subscriptionCancelledAt = moment().toDate();
-    }
+
     await UserModel.updateOne({ _id: target }, query);
     res.status(statusCodes.success).json(new SuccessResponse());
     flushUserInfoFromRedis(target);