feat(server): deprecated the subscription module.

packages/server/src/api/controllers/Organization.ts

@@ -6,7 +6,6 @@ import { check, ValidationChain } from 'express-validator';
 import asyncMiddleware from '@/api/middleware/asyncMiddleware';
 import JWTAuth from '@/api/middleware/jwtAuth';
 import TenancyMiddleware from '@/api/middleware/TenancyMiddleware';
-import SubscriptionMiddleware from '@/api/middleware/SubscriptionMiddleware';
 import AttachCurrentTenantUser from '@/api/middleware/AttachCurrentTenantUser';
 import OrganizationService from '@/services/Organization/OrganizationService';
 import {
@@ -24,7 +23,7 @@ const ACCEPTED_LOCATIONS = ['libya'];
 @Service()
 export default class OrganizationController extends BaseController {
   @Inject()
-  organizationService: OrganizationService;
+  private organizationService: OrganizationService;
 
   /**
    * Router constructor.
@@ -32,13 +31,10 @@ export default class OrganizationController extends BaseController {
   router() {
     const router = Router();
 
-    // Should before build tenant database the user be authorized and
-    // most important than that, should be subscribed to any plan.
     router.use(JWTAuth);
     router.use(AttachCurrentTenantUser);
     router.use(TenancyMiddleware);
 
-    router.use('/build', SubscriptionMiddleware('main'));
     router.post(
       '/build',
       this.organizationValidationSchema,

packages/server/src/api/controllers/Subscription/Licenses.ts

@@ -1,250 +0,0 @@
-import { Service, Inject } from 'typedi';
-import { Router, Request, Response, NextFunction } from 'express';
-import { check, oneOf, ValidationChain } from 'express-validator';
-import basicAuth from 'express-basic-auth';
-import config from '@/config';
-import { License } from '@/system/models';
-import { ServiceError } from '@/exceptions';
-import BaseController from '@/api/controllers/BaseController';
-import LicenseService from '@/services/Payment/License';
-import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import { ILicensesFilter, ISendLicenseDTO } from '@/interfaces';
-
-@Service()
-export default class LicensesController extends BaseController {
-  @Inject()
-  licenseService: LicenseService;
-
-  /**
-   * Router constructor.
-   */
-  router() {
-    const router = Router();
-
-    router.use(
-      basicAuth({
-        users: {
-          [config.licensesAuth.user]: config.licensesAuth.password,
-        },
-        challenge: true,
-      })
-    );
-    router.post(
-      '/generate',
-      this.generateLicenseSchema,
-      this.validationResult,
-      asyncMiddleware(this.generateLicense.bind(this)),
-      this.catchServiceErrors,
-    );
-    router.post(
-      '/disable/:licenseId',
-      this.validationResult,
-      asyncMiddleware(this.disableLicense.bind(this)),
-      this.catchServiceErrors,
-    );
-    router.post(
-      '/send',
-      this.sendLicenseSchemaValidation,
-      this.validationResult,
-      asyncMiddleware(this.sendLicense.bind(this)),
-      this.catchServiceErrors,
-    );
-    router.delete(
-      '/:licenseId',
-      asyncMiddleware(this.deleteLicense.bind(this)),
-      this.catchServiceErrors,
-    );
-    router.get('/', asyncMiddleware(this.listLicenses.bind(this)));
-    return router;
-  }
-
-  /**
-   * Generate license validation schema.
-   */
-  get generateLicenseSchema(): ValidationChain[] {
-    return [
-      check('loop').exists().isNumeric().toInt(),
-      check('period').exists().isNumeric().toInt(),
-      check('period_interval')
-        .exists()
-        .isIn(['month', 'months', 'year', 'years', 'day', 'days']),
-      check('plan_slug').exists().trim().escape(),
-    ];
-  }
-
-  /**
-   * Specific license validation schema.
-   */
-  get specificLicenseSchema(): ValidationChain[] {
-    return [
-      oneOf(
-        [check('license_id').exists().isNumeric().toInt()],
-        [check('license_code').exists().isNumeric().toInt()]
-      ),
-    ];
-  }
-
-  /**
-   * Send license validation schema.
-   */
-  get sendLicenseSchemaValidation(): ValidationChain[] {
-    return [
-      check('period').exists().isNumeric(),
-      check('period_interval').exists().trim().escape(),
-      check('plan_slug').exists().trim().escape(),
-      oneOf([
-        check('phone_number').exists().trim().escape(),
-        check('email').exists().trim().escape(),
-      ]),
-    ];
-  }
-
-  /**
-   * Generate licenses codes with given period in bulk.
-   * @param {Request} req
-   * @param {Response} res
-   * @return {Response}
-   */
-  async generateLicense(req: Request, res: Response, next: Function) {
-    const { loop = 10, period, periodInterval, planSlug } = this.matchedBodyData(
-      req
-    );
-
-    try {
-      await this.licenseService.generateLicenses(
-        loop,
-        period,
-        periodInterval,
-        planSlug
-      );
-      return res.status(200).send({
-        code: 100,
-        type: 'LICENSEES.GENERATED.SUCCESSFULLY',
-        message: 'The licenses have been generated successfully.',
-      });
-    } catch (error) {
-      next(error);
-    }
-  }
-
-  /**
-   * Disable the given license on the storage.
-   * @param {Request} req
-   * @param {Response} res
-   * @return {Response}
-   */
-  async disableLicense(req: Request, res: Response, next: Function) {
-    const { licenseId } = req.params;
-
-    try {
-      await this.licenseService.disableLicense(licenseId);
-
-      return res.status(200).send({ license_id: licenseId });
-    } catch (error) {
-      next(error);
-    }
-  }
-
-  /**
-   * Deletes the given license code on the storage.
-   * @param {Request} req
-   * @param {Response} res
-   * @return {Response}
-   */
-  async deleteLicense(req: Request, res: Response, next: Function) {
-    const { licenseId } = req.params;
-
-    try {
-      await this.licenseService.deleteLicense(licenseId);
-
-      return res.status(200).send({ license_id: licenseId });
-    } catch (error) {
-      next(error)
-    }
-  }
-
-  /**
-   * Send license code in the given period to the customer via email or phone number
-   * @param {Request} req
-   * @param {Response} res
-   * @return {Response}
-   */
-  async sendLicense(req: Request, res: Response, next: Function) {
-    const sendLicenseDTO: ISendLicenseDTO = this.matchedBodyData(req);
-
-    try {
-      await this.licenseService.sendLicenseToCustomer(sendLicenseDTO);
-
-      return res.status(200).send({
-        status: 100,
-        code: 'LICENSE.CODE.SENT',
-        message: 'The license has been sent to the given customer.',
-      });
-    } catch (error) {
-      next(error);
-    }
-  }
-
-  /**
-   * Listing licenses.
-   * @param {Request} req
-   * @param {Response} res
-   */
-  async listLicenses(req: Request, res: Response) {
-    const filter: ILicensesFilter = {
-      disabled: false,
-      used: false,
-      sent: false,
-      active: false,
-      ...req.query,
-    };
-    const licenses = await License.query().onBuild((builder) => {
-      builder.modify('filter', filter);
-      builder.orderBy('createdAt', 'ASC');
-    });
-    return res.status(200).send({ licenses });
-  }
-
-  /**
-   * Catches all service errors.
-   */
-  catchServiceErrors(error, req: Request, res: Response, next: NextFunction) {
-    if (error instanceof ServiceError) {
-      if (error.errorType === 'PLAN_NOT_FOUND') {
-        return res.status(400).send({
-          errors: [{
-            type: 'PLAN.NOT.FOUND',
-            code: 100,
-            message: 'The given plan not found.',
-        }],
-        });
-      }
-      if (error.errorType === 'LICENSE_NOT_FOUND') {
-        return res.status(400).send({
-          errors: [{
-            type: 'LICENSE_NOT_FOUND',
-            code: 200,
-            message: 'The given license id not found.'
-          }],
-        });
-      }
-      if (error.errorType === 'LICENSE_ALREADY_DISABLED') {
-        return res.status(400).send({
-          errors: [{
-            type: 'LICENSE.ALREADY.DISABLED',
-            code: 200, 
-            message: 'License is already disabled.'
-          }],
-        });
-      }
-      if (error.errorType === 'NO_AVALIABLE_LICENSE_CODE') {
-        return res.status(400).send({
-          status: 110,
-          message: 'There is no licenses availiable right now with the given period and plan.',
-          code: 'NO.AVALIABLE.LICENSE.CODE',
-        });
-      }
-    }
-    next(error);
-  }
-}

packages/server/src/api/controllers/Subscription/PaymentMethod.ts

@@ -1,31 +0,0 @@
-import { Inject } from 'typedi';
-import { Request, Response } from 'express';
-import { Plan } from '@/system/models';
-import BaseController from '@/api/controllers/BaseController';
-import SubscriptionService from '@/services/Subscription/SubscriptionService';
-
-export default class PaymentMethodController extends BaseController {
-  @Inject()
-  subscriptionService: SubscriptionService;
-
-  /**
-   * Validate the given plan slug exists on the storage.
-   * 
-   * @param {Request} req 
-   * @param {Response} res 
-   * @param {NextFunction} next
-   * 
-   * @return {Response|void}
-   */
-  async validatePlanSlugExistance(req: Request, res: Response, next: Function) {
-    const { planSlug } = this.matchedBodyData(req);
-    const foundPlan = await Plan.query().where('slug', planSlug).first();
-
-    if (!foundPlan) {
-      return res.status(400).send({
-        errors: [{ type: 'PLAN.SLUG.NOT.EXISTS', code: 110 }],
-      });
-    }
-    next();
-  }
-}

packages/server/src/api/controllers/Subscription/PaymentViaLicense.ts

@@ -1,125 +0,0 @@
-import { Inject, Service } from 'typedi';
-import { NextFunction, Router, Request, Response } from 'express';
-import { check } from 'express-validator';
-import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-import PaymentMethodController from '@/api/controllers/Subscription/PaymentMethod';
-import {
-  NotAllowedChangeSubscriptionPlan,
-  NoPaymentModelWithPricedPlan,
-  PaymentAmountInvalidWithPlan,
-  PaymentInputInvalid,
-  VoucherCodeRequired,
-} from '@/exceptions';
-import { ILicensePaymentModel } from '@/interfaces';
-import instance from 'tsyringe/dist/typings/dependency-container';
-
-@Service()
-export default class PaymentViaLicenseController extends PaymentMethodController {
-  @Inject('logger')
-  logger: any;
-
-  /**
-   * Router constructor.
-   */
-  router() {
-    const router = Router();
-
-    router.post(
-      '/payment',
-      this.paymentViaLicenseSchema,
-      this.validationResult,
-      asyncMiddleware(this.validatePlanSlugExistance.bind(this)),
-      asyncMiddleware(this.paymentViaLicense.bind(this)),
-      this.handleErrors,
-    );
-    return router;
-  }
-
-  /**
-   * Payment via license validation schema.
-   */
-  get paymentViaLicenseSchema() {
-    return [
-      check('plan_slug').exists().trim().escape(),
-      check('license_code').exists().trim().escape(),
-    ];
-  }
-
-  /**
-   * Handle the subscription payment via license code.
-   * @param {Request} req
-   * @param {Response} res
-   * @return {Response}
-   */
-  async paymentViaLicense(req: Request, res: Response, next: Function) {
-    const { planSlug, licenseCode } = this.matchedBodyData(req);
-    const { tenant } = req;
-
-    try {
-      const licenseModel: ILicensePaymentModel = { licenseCode };
-
-      await this.subscriptionService.subscriptionViaLicense(
-        tenant.id,
-        planSlug,
-        licenseModel
-      );
-
-      return res.status(200).send({
-        type: 'success',
-        code: 'PAYMENT.SUCCESSFULLY.MADE',
-        message: 'Payment via license has been made successfully.',
-      });
-    } catch (exception) {
-      next(exception);
-    }
-  }
-
-  /**
-   * Handle service errors.
-   * @param {Error} error
-   * @param {Request} req
-   * @param {Response} res
-   * @param {NextFunction} next
-   */
-  private handleErrors(
-    exception: Error,
-    req: Request,
-    res: Response,
-    next: NextFunction
-  ) {
-    const errorReasons = [];
-
-    if (exception instanceof VoucherCodeRequired) {
-      errorReasons.push({
-        type: 'VOUCHER_CODE_REQUIRED',
-        code: 100,
-      });
-    }
-    if (exception instanceof NoPaymentModelWithPricedPlan) {
-      errorReasons.push({
-        type: 'NO_PAYMENT_WITH_PRICED_PLAN',
-        code: 140,
-      });
-    }
-    if (exception instanceof NotAllowedChangeSubscriptionPlan) {
-      errorReasons.push({
-        type: 'NOT.ALLOWED.RENEW.SUBSCRIPTION.WHILE.ACTIVE',
-        code: 120,
-      });
-    }
-    if (errorReasons.length > 0) {
-      return res.status(400).send({ errors: errorReasons });
-    }
-    if (exception instanceof PaymentInputInvalid) {
-      return res.status(400).send({
-        errors: [{ type: 'LICENSE.CODE.IS.INVALID', code: 120 }],
-      });
-    }
-    if (exception instanceof PaymentAmountInvalidWithPlan) {
-      return res.status(400).send({
-        errors: [{ type: 'LICENSE.NOT.FOR.GIVEN.PLAN' }],
-      });
-    }
-    next(exception);
-  }
-}

packages/server/src/api/controllers/Subscription/index.ts

@@ -1,49 +0,0 @@
-import { Router, Request, Response, NextFunction } from 'express';
-import { Container, Service, Inject } from 'typedi';
-import JWTAuth from '@/api/middleware/jwtAuth';
-import TenancyMiddleware from '@/api/middleware/TenancyMiddleware';
-import AttachCurrentTenantUser from '@/api/middleware/AttachCurrentTenantUser';
-import PaymentViaLicenseController from '@/api/controllers/Subscription/PaymentViaLicense';
-import SubscriptionService from '@/services/Subscription/SubscriptionService';
-import asyncMiddleware from '@/api/middleware/asyncMiddleware';
-
-@Service()
-export default class SubscriptionController {
-  @Inject()
-  subscriptionService: SubscriptionService;
-
-  /**
-   * Router constructor.
-   */
-  router() {
-    const router = Router();
-
-    router.use(JWTAuth);
-    router.use(AttachCurrentTenantUser);
-    router.use(TenancyMiddleware);
-
-    router.use('/license', Container.get(PaymentViaLicenseController).router());
-    router.get('/', asyncMiddleware(this.getSubscriptions.bind(this)));
-
-    return router;
-  }
-
-  /**
-   * Retrieve all subscriptions of the authenticated user's tenant.
-   * @param {Request} req
-   * @param {Response} res
-   * @param {NextFunction} next
-   */
-  async getSubscriptions(req: Request, res: Response, next: NextFunction) {
-    const { tenantId } = req;
-
-    try {
-      const subscriptions = await this.subscriptionService.getSubscriptions(
-        tenantId
-      );
-      return res.status(200).send({ subscriptions });
-    } catch (error) {
-      next(error);
-    }
-  }
-}