feat/impersonation - types and constants (#2431)

* added types file for impersonation Requests

* all types and constants required for impersonation

* fixed constants and types according to review comments

* updated isImpersonationStarted field to isImpersonationFinished

Author: Suvidh-kaushik

config/custom-environment-variables.js

@@ -88,6 +88,10 @@ module.exports = {
       __name: "USER_TOKEN_REFRESH_TTL",
       __format: "number",
     },
+    impersonationTtl: {
+      __name: "USER_TOKEN_IMPERSONATION_TTL",
+      __format: "number",
+    },
     publicKey: "PUBLIC_KEY",
     privateKey: "PRIVATE_KEY",
   },

config/default.js

@@ -86,6 +86,7 @@ module.exports = {
     cookieV2Name: `rds-session-v2-${NODE_ENV}`,
     ttl: 30 * 24 * 60 * 60, // in seconds
     refreshTtl: 180 * 24 * 60 * 60, // in seconds
+    impersonationTtl: 15 * 60, // in seconds
     publicKey: "<publicKey>",
     privateKey: "<privateKey>",
   },

constants/requests.ts

@@ -68,3 +68,9 @@ export const INVALID_REQUEST_TYPE = "Invalid request type";
 export const INVALID_REQUEST_DEADLINE = "New deadline of the request must be greater than old deadline";
 export const REQUEST_UPDATED_SUCCESSFULLY = "Request updated successfully";
 export const UNAUTHORIZED_TO_UPDATE_REQUEST = "Unauthorized to update request";
+
+export const FEATURE_NOT_IMPLEMENTED = "Feature not implemented";
+
+export const IMPERSONATION_NOT_COMPLETED = "Please complete impersonation before creating a new request";
+export const IMPERSONATION_ALREADY_ATTEMPTED = "No active request is available for impersonation";
+export const IMPERSONATION_REQUEST_NOT_APPROVED = "Awaiting approval for impersonation request";

types/impersonationRequest.d.ts

@@ -0,0 +1,81 @@
+import { Request, Response } from "express";
+import { REQUEST_STATE } from "../constants/requests";
+import { Boom } from "express-boom";
+import {RequestQuery } from "./requests";
+import { userData } from "./global";
+import { Timestamp } from "firebase-admin/firestore";
+
+export type ImpersonationRequest = {
+    id: string;
+    status: REQUEST_STATE;
+    isImpersonationFinished: boolean;
+    createdBy: string;
+    createdFor: string;
+    userId: string;
+    reason: string;
+    message?: string;
+    impersonatedUserId: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    startedAt?: Timestamp;
+    endedAt?: Timestamp;
+}
+
+export type CreateImpersonationRequestBody = {
+   impersonatedUserId: string;
+   reason: string;
+};
+
+export type CreateImpersonationRequestModelBody = {
+    status: REQUEST_STATE;
+    isImpersonationFinished: boolean;
+    createdBy: string;
+    createdFor: string;
+    userId: string;
+    reason: string;
+    impersonatedUserId: string;
+}
+
+export type UpdateImpersonationRequestDataBody = {
+    startedAt?: Timestamp;
+    endedAt: Timestamp;
+    isImpersonationFinished?: boolean;
+}
+
+export type UpdateImpersonationRequestStatusBody = {
+    status: REQUEST_STATE.APPROVED | REQUEST_STATE.REJECTED;
+    message?: string;
+}
+
+export type ImpersonationRequestQuery = RequestQuery & {
+    dev?: string;
+};
+
+export type ImpersonationRequestResponse = Response & {
+    boom: Boom;
+};
+
+export type RequestParams = {
+    id: string;
+}
+
+export type CreateImpersonationRequest = Request & {
+   userData: userData;
+   body: CreateImpersonationRequestBody;
+   query: ImpersonationRequestQuery;
+};
+
+export type UpdateImpersonationRequestStatus = Request & {
+    userData: userData;
+    body: UpdateImpersonationRequestStatusBody;
+    query: ImpersonationRequestQuery;
+    params: RequestParams;
+}
+
+export type PaginatedImpersonationRequests = {
+    allRequests: ImpersonationRequest[];
+    next: string;
+    prev: string;
+    page: number;
+    count: number;
+}