[Customer Portal][FE][Web] Project Structure Refactor and Project Switcher Enhancements

apps/customer-portal/backend/constants.bal

@@ -22,6 +22,9 @@ const ERR_MSG_CASE_ACCESS_FORBIDDEN = "Access to the requested case is forbidden
 const ERR_MSG_FETCHING_PROJECT_DETAILS = "Error retrieving project details!";
 const ERR_MSG_PROJECT_ID_EMPTY = "Project ID cannot be empty!";
 const ERR_MSG_CASE_ID_EMPTY = "Case ID cannot be empty!";
+const ERR_LIMIT_OFFSET_INVALID = "Limit must be between 1 and 50. Offset must be a non-negative integer!";
+const ERR_MSG_UNAUTHORIZED_ACCESS = "You're not authorized to access this service. Please sign in again." +
+    "If the issue continues, contact support.";
 
 // Default Pagination Values
 public const int DEFAULT_OFFSET = 0;

apps/customer-portal/backend/modules/entity/constants.bal

@@ -16,4 +16,4 @@
 
 # Default pagination values.
 const DEFAULT_OFFSET = 0;
-const DEFAULT_LIMIT = 10;
+const DEFAULT_LIMIT = 20;

apps/customer-portal/backend/modules/entity/entity.bal

@@ -27,8 +27,8 @@ public isolated function getUserBasicInfo(string email, string idToken) returns
 #
 # + idToken - ID token for authorization
 # + projectId - Unique ID of the project
-# + return - Project details or error
-public isolated function getProject(string idToken, string projectId) returns ProjectDetailsResponse|error {
+# + return - Project response or error
+public isolated function getProject(string idToken, string projectId) returns ProjectResponse|error {
     return csEntityClient->/projects/[projectId].get(generateHeaders(idToken));
 }
 
@@ -37,12 +37,12 @@ public isolated function getProject(string idToken, string projectId) returns Pr
 # + idToken - ID token for authorization
 # + payload - Payload for searching projects
 # + return - Projects response or error
-public isolated function searchProjects(string idToken, ProjectPayload payload) returns ProjectsResponse|error {
+public isolated function searchProjects(string idToken, ProjectSearchPayload payload) returns ProjectsResponse|error {
     return csEntityClient->/projects/search.post(payload, generateHeaders(idToken));
 }
 
 # Get project activity statistics by ID.
-# 
+#
 # + idToken - ID token for authorization
 # + id - Unique ID of the project
 # + return - Project statistics or error
@@ -51,7 +51,7 @@ public isolated function getProjectActivityStats(string idToken, string id) retu
 }
 
 # Get cases statistics of a project by ID.
-# 
+#
 # + idToken - ID token for authorization
 # + id - Unique ID of the project
 # + return - Project cases statistics or error
@@ -60,7 +60,7 @@ public isolated function getCaseStatsForProject(string idToken, string id) retur
 }
 
 # Get chats statistics of a project by ID.
-# 
+#
 # + idToken - ID token for authorization
 # + id - Unique ID of the project
 # + return - Project chats statistics or error
@@ -69,7 +69,7 @@ public isolated function getChatStatsForProject(string idToken, string id) retur
 }
 
 # Get deployments statistics of a project by ID.
-# 
+#
 # + idToken - ID token for authorization
 # + id - Unique ID of the project
 # + return - Project deployments statistics or error
@@ -110,6 +110,17 @@ public isolated function getCaseMetadata(string idToken) returns CaseMetadataRes
 # + idToken - ID token for authorization
 # + payload - Comment request payload
 # + return - Comments response or error
-public isolated function searchComments(string idToken, CommentRequestPayload payload) returns CommentsResponse|error {
+public isolated function searchComments(string idToken, ReferenceSearchPayload payload) returns CommentsResponse|error {
     return csEntityClient->/comments/search.post(payload, generateHeaders(idToken));
 }
+
+# Search attachments.
+#
+# + idToken - ID token for authorization
+# + payload - Attachment request payload
+# + return - Attachments response or error
+public isolated function searchAttachments(string idToken, ReferenceSearchPayload payload)
+    returns AttachmentsResponse|error {
+
+    return csEntityClient->/attachments/search.post(payload, generateHeaders(idToken));
+}

apps/customer-portal/backend/modules/entity/types.bal

@@ -55,10 +55,10 @@ public type UserResponse record {|
     string id;
     # Email address
     string email;
-    # First name
-    string firstName;
     # Last name
     string lastName;
+    # First name
+    string? firstName;
     # Time zone
     string? timeZone;
     json...;
@@ -79,8 +79,8 @@ public type Project record {|
     json...;
 |};
 
-# Request body for searching projects.
-public type ProjectPayload record {|
+# Payload for searching projects.
+public type ProjectSearchPayload record {|
     # Pagination details
     Pagination pagination = {};
 |};
@@ -95,20 +95,18 @@ public type ProjectsResponse record {|
     json...;
 |};
 
-# Project details information.
-public type ProjectDetailsResponse record {|
+# Project information.
+public type ProjectResponse record {|
     *Project;
     # Project type
     string 'type;
-    # SLA status
-    string slaStatus;
     # Subscription information
-    ProjectSubscription? subscription;
+    Subscription? subscription;
     json...;
 |};
 
 # Project subscription information.
-public type ProjectSubscription record {|
+public type Subscription record {|
     # Subscription start date
     string? startDate;
     # Subscription end date
@@ -237,11 +235,11 @@ public type SortBy record {|
 
 # Case metadata response.
 public type CaseMetadataResponse record {|
-    # List of available case states
+    # List of available case states (eg: Open, Closed, etc.)
     ChoiceListItem[] states;
-    # List of available case severities
+    # List of available case severities (eg: S0, S1, etc.)
     ChoiceListItem[] severities;
-    # List of available case types
+    # List of available case types (eg: Incident, Service Request, etc.)
     ReferenceTableItem[] caseTypes;
     json...;
 |};
@@ -254,6 +252,8 @@ public type ProjectStatsResponse record {|
     decimal billableHours;
     # System health status
     string systemHealth;
+    # SLA status
+    string slaStatus;
     json...;
 |};
 
@@ -270,8 +270,8 @@ public type ActiveCaseCount record {|
     json...;
 |};
 
-# Outstanding incidents count breakdown.
-public type OutstandingIncidentsCount record {|
+# Outstanding cases count breakdown.
+public type OutstandingCasesCount record {|
     # Medium severity count
     int medium;
     # High severity count
@@ -302,8 +302,8 @@ public type ProjectCaseStatsResponse record {|
     decimal averageResponseTime;
     # Active case count breakdown
     ActiveCaseCount activeCount;
-    # Outstanding incidents count breakdown
-    OutstandingIncidentsCount outstandingIncidentsCount;
+    # Outstanding cases count breakdown
+    OutstandingCasesCount outstandingCasesCount;
     # Resolved case count breakdown
     ResolvedCaseCount resolvedCount;
     json...;
@@ -332,7 +332,7 @@ public type ProjectDeploymentStatsResponse record {|
 public type Comment record {|
     # ID
     string id;
-    # Reference ID associated with the comment
+    # Reference ID associated with the comment(query ID, incident ID, service request ID, etc.)
     string referenceId;
     # Content of the comment
     string content;
@@ -357,10 +357,40 @@ public type CommentsResponse record {|
     json...;
 |};
 
-# Request payload for searching comments.
-public type CommentRequestPayload record {|
-    # Reference ID to filter comments
+# Reference search payload to search comments, attachments, etc.
+public type ReferenceSearchPayload record {|
+    # Reference ID to filter related resources(query ID, incident ID, service request ID, etc.)
     string referenceId;
     # Pagination details
     Pagination pagination?;
 |};
+
+# Attachment data.
+public type Attachment record {|
+    # ID of the attachment
+    string id;
+    # Reference ID associated with the attachment(query ID, incident ID, service request ID, etc.)
+    string referenceId;
+    # File name
+    string name;
+    # MIME type of the file
+    string 'type;
+    # File size in bytes
+    string sizeBytes;
+    # User who created the attachment
+    string createdBy;
+    # Created date and time
+    string createdOn;
+    # Download URL
+    string downloadUrl;
+    json...;
+|};
+
+# Attachments response.
+public type AttachmentsResponse record {|
+    # List of attachments
+    Attachment[] attachments;
+    # Total records count
+    int totalRecords;
+    *Pagination;
+|};

apps/customer-portal/backend/modules/entity/utils.bal

@@ -21,14 +21,16 @@
 isolated function generateHeaders(string token) returns map<string|string[]> => {"x-user-id-token": token};
 
 # Get comments for a given entity ID with pagination.
-# 
+#
 # + idToken - ID token for authorization
 # + id - Entity ID to filter comments
 # + limit - Number of comments to retrieve
 # + offset - Offset for pagination
 # + return - Comments response or error
-public isolated function getComments(string idToken, string id, int? 'limit, int? offset) returns CommentsResponse|error {
-    CommentRequestPayload payload = {
+public isolated function getComments(string idToken, string id, int? 'limit, int? offset)
+    returns CommentsResponse|error {
+
+    ReferenceSearchPayload payload = {
         referenceId: id,
         pagination: {
             'limit: 'limit ?: DEFAULT_LIMIT,
@@ -37,3 +39,23 @@ public isolated function getComments(string idToken, string id, int? 'limit, int
     };
     return searchComments(idToken, payload);
 }
+
+# Get attachments for a given entity ID with pagination.
+#
+# + idToken - ID token for authorization
+# + id - Entity ID to filter attachments
+# + limit - Number of attachments to retrieve
+# + offset - Offset for pagination
+# + return - Attachments response or error
+public isolated function getAttachments(string idToken, string id, int? 'limit, int? offset)
+    returns AttachmentsResponse|error {
+
+    ReferenceSearchPayload payload = {
+        referenceId: id,
+        pagination: {
+            'limit: 'limit ?: DEFAULT_LIMIT,
+            offset: offset ?: DEFAULT_OFFSET
+        }
+    };
+    return searchAttachments(idToken, payload);
+}