Skip to content

feat: Create back-end for the new users panel page#31898

Merged
kodiakhq[bot] merged 30 commits intodevelopfrom
feat/new-user-panel-backend
Apr 20, 2024
Merged

feat: Create back-end for the new users panel page#31898
kodiakhq[bot] merged 30 commits intodevelopfrom
feat/new-user-panel-backend

Conversation

@rique223
Copy link
Copy Markdown
Contributor

@rique223 rique223 commented Mar 5, 2024

Proposed changes (including videos or screenshots)

This pull request introduces the necessary backend elements for the new users page. These include:

  1. New endpoints with JSON schema validation for their payloads:

    • api/v1/users.listByStatus: Returns a paginated and/or filtered list of users with the following query parameters:

      status: 'active' | 'deactivated'; // The type of user based on their status to be returned by the endpoint;
      hasLoggedIn: boolean; // If true, only returns users who have logged in for the firs time;
      type: string; // The type of users to be returned, e.g.: 'bot', 'user', 'app', etc;
      roles?: string[]; // A list of user roles; the returned users list will be filtered based on this list
      searchTerm?: string; // A search term; the returned users list will only include users with this term in their email, name, or username
      sort?: string; // The sorting order of the returned users list
      count?: number; // Number of items in the returned users list
      offset?: number; // The index at which the returned users list will start, helping to define the current page for pagination
    • api/v1/users.sendWelcomeEmail: Sends the welcome email template to the provided email address with the following query parameters:

      email: string; // The email address of the user to receive the welcome message
  2. Created API tests for the aforementioned endpoints.

  3. Improved typing for the users.ts rest-typings.

Issue(s)

Steps to test or reproduce

Further comments

Related to: #30236
Jira: WM-51

Created a helper function named isSMTPConfigured.ts to run when calling the smtp.check endpoint of the misc.ts group.
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 5, 2024

🦋 Changeset detected

Latest commit: d203d48

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 32 packages
Name Type
@rocket.chat/meteor Minor
@rocket.chat/rest-typings Minor
@rocket.chat/core-services Patch
@rocket.chat/ui-contexts Major
@rocket.chat/account-service Patch
@rocket.chat/authorization-service Patch
@rocket.chat/ddp-streamer Patch
@rocket.chat/stream-hub-service Patch
@rocket.chat/api-client Patch
@rocket.chat/ddp-client Patch
@rocket.chat/omnichannel-services Patch
@rocket.chat/presence Patch
rocketchat-services Patch
@rocket.chat/omnichannel-transcript Patch
@rocket.chat/presence-service Patch
@rocket.chat/queue-worker Patch
@rocket.chat/fuselage-ui-kit Major
@rocket.chat/gazzodown Major
@rocket.chat/livechat Patch
@rocket.chat/ui-avatar Major
@rocket.chat/ui-client Major
@rocket.chat/ui-video-conf Major
@rocket.chat/uikit-playground Patch
@rocket.chat/web-ui-registration Major
@rocket.chat/core-typings Minor
@rocket.chat/apps Patch
@rocket.chat/cron Patch
@rocket.chat/model-typings Patch
@rocket.chat/license Patch
@rocket.chat/pdf-worker Patch
@rocket.chat/models Patch
@rocket.chat/instance-status Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.68%. Comparing base (17bc631) to head (d203d48).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #31898      +/-   ##
===========================================
- Coverage    55.01%   54.68%   -0.33%     
===========================================
  Files         2278     2299      +21     
  Lines        50402    50919     +517     
  Branches     10264    10423     +159     
===========================================
+ Hits         27729    27846     +117     
- Misses       20195    20606     +411     
+ Partials      2478     2467      -11     
Flag Coverage Δ
e2e 53.45% <ø> (-0.62%) ⬇️
unit 74.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@rique223 rique223 added this to the 7.0 milestone Mar 6, 2024
@rique223 rique223 marked this pull request as ready for review March 8, 2024 14:02
@rique223 rique223 requested review from a team as code owners March 8, 2024 14:02
@dionisio-bot
Copy link
Copy Markdown
Contributor

dionisio-bot bot commented Apr 3, 2024

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

@tassoevan tassoevan modified the milestones: 7.0, 6.8 Apr 15, 2024
@tassoevan tassoevan requested a review from a team April 15, 2024 22:25
@dionisio-bot dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge stat: QA assured Means it has been tested and approved by a company insider and removed stat: QA tested labels Apr 16, 2024
@kodiakhq kodiakhq bot merged commit 845fd64 into develop Apr 20, 2024
@kodiakhq kodiakhq bot deleted the feat/new-user-panel-backend branch April 20, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stat: QA assured Means it has been tested and approved by a company insider stat: ready to merge PR tested and approved waiting for merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants