Add "list-new-joiners" command

Author: ba1uev

src/admin-api/index.ts

@@ -125,6 +125,22 @@ class AdminApi {
     return users
   }
 
+  async getNewUserAccounts(limit: number): Promise<UserAccountShort[]> {
+    let users: UserAccountShort[] = []
+    let nextToken: string | null = null
+    let total: number | null = null
+    do {
+      const result = (await this.makeRequest(
+        "GET",
+        `/v2/users?limit=${limit}${nextToken ? `&from=${nextToken}` : ``}&guests=false&order_by=creation_ts&dir=desc`,
+      )) as UserAccountsResponse
+      users = users.concat(result.users)
+      nextToken = result.next_token || null
+      total = result.total
+    } while (nextToken !== null || users.length < total)
+    return users
+  }
+
   async getRooms(): Promise<RoomInfoShort[]> {
     const limit = 50
     let rooms: RoomInfoShort[] = []

src/bot.ts

@@ -1,5 +1,6 @@
 import { LogService, MatrixClient, MatrixProfileInfo, MessageEvent, UserID } from "matrix-bot-sdk"
 
+import { LIST_NEW_JOINERS_COMMAND, runListNewJoinersCommand } from "src/commands/list-new-joiners"
 import { LIST_ROOMS_COMMAND, runListRoomsCommand } from "src/commands/list-rooms"
 import { LIST_SPACES_COMMAND, runListSpacesCommand } from "src/commands/list-spaces"
 import config from "src/config/env"
@@ -108,6 +109,8 @@ export default class Bot {
           return await runListRoomsCommand(roomId, event, this.client, args[1])
         case LIST_SPACES_COMMAND:
           return await runListSpacesCommand(roomId, event, this.client)
+        case LIST_NEW_JOINERS_COMMAND:
+          return await runListNewJoinersCommand(roomId, event, this.client, args)
         case PROMOTE_COMMAND:
           return await runPromoteCommand(roomId, event, args, this.client, this.userId)
         case DELETE_ROOM_COMMAND:

src/commands/help.ts

@@ -2,15 +2,21 @@ import htmlEscape from "escape-html"
 import { MatrixClient, MessageEvent, MessageEventContent, RichReply } from "matrix-bot-sdk"
 
 import { ACCOUNT_COMMAND, Command as AccountSubcommand } from "src/commands/account"
-import { WELCOME_MESSAGE_COMMAND, Command as WelcomeMessageSubcommand } from "src/commands/welcome-message"
 import { BULK_INVITE_COMMAND } from "src/commands/bulk-invite"
 import { DEACTIVATE_USER_COMMAND } from "src/commands/deactivate-user"
 import { DELETE_ROOM_COMMAND } from "src/commands/delete-room"
 import { defaultGroups, INVITE_COMMAND } from "src/commands/invite"
+import {
+  LIST_NEW_JOINERS_COMMAND,
+  LIST_NEW_JOINERS_DEFAULT_LIMIT,
+  LIST_NEW_JOINERS_MAX_LIMIT,
+  LIST_NEW_JOINERS_MIN_LIMIT,
+} from "src/commands/list-new-joiners"
 import { LIST_ROOMS_COMMAND } from "src/commands/list-rooms"
 import { LIST_SPACES_COMMAND } from "src/commands/list-spaces"
 import { PROMOTE_COMMAND } from "src/commands/promote"
 import { SPACE_COMMAND } from "src/commands/space"
+import { Command as WelcomeMessageSubcommand, WELCOME_MESSAGE_COMMAND } from "src/commands/welcome-message"
 import config from "src/config/env"
 import { groupedRooms } from "src/config/rooms"
 import { commandPrefix } from "src/constants"
@@ -37,6 +43,12 @@ ${commandPrefix} ${LIST_SPACES_COMMAND}
 
 --------------------------------------------------
 
+${commandPrefix} ${LIST_NEW_JOINERS_COMMAND} [<number>]
+    Show the last registered users on the server.
+    [<number>]  - (Optional) how many users to list. Default: ${LIST_NEW_JOINERS_DEFAULT_LIMIT}, Min: ${LIST_NEW_JOINERS_MIN_LIMIT}, Max: ${LIST_NEW_JOINERS_MAX_LIMIT}
+
+--------------------------------------------------
+
 ${commandPrefix} ${SPACE_COMMAND} <spaceId> [list | add | remove] [<roomId>]
     A command for managing spacess. See examples below.
     <spaceId>    - Matrix room id or alias for the space

src/commands/list-new-joiners.ts

@@ -0,0 +1,53 @@
+import { MatrixClient, MessageEvent, MessageEventContent } from "matrix-bot-sdk"
+
+import { adminApi } from "src/admin-api"
+import { canExecuteCommand, CommandError, sendMessage } from "src/utils"
+
+export const LIST_NEW_JOINERS_COMMAND = "list-new-joiners"
+export const LIST_NEW_JOINERS_DEFAULT_LIMIT = 10
+export const LIST_NEW_JOINERS_MIN_LIMIT = 1
+export const LIST_NEW_JOINERS_MAX_LIMIT = 100
+
+export async function runListNewJoinersCommand(
+  roomId: string,
+  event: MessageEvent<MessageEventContent>,
+  client: MatrixClient,
+  args: string[],
+): Promise<string> {
+  // Ensure the user can execute the command
+  const canExecute = await canExecuteCommand(event.sender, roomId)
+  if (!canExecute) {
+    throw new CommandError(`Access denied`)
+  }
+
+  // Parse optional limit argument
+  const limitArg = args?.[1]
+  let limit = LIST_NEW_JOINERS_DEFAULT_LIMIT
+  if (limitArg !== undefined) {
+    const parsed = Number(limitArg)
+    if (!Number.isFinite(parsed)) {
+      throw new CommandError(
+        `Invalid limit. Provide a number between ${LIST_NEW_JOINERS_MIN_LIMIT} and ${LIST_NEW_JOINERS_MAX_LIMIT}.`,
+      )
+    }
+    const floored = Math.floor(parsed)
+    limit = Math.min(LIST_NEW_JOINERS_MAX_LIMIT, Math.max(LIST_NEW_JOINERS_MIN_LIMIT, floored))
+  }
+
+  const users = await adminApi.getNewUserAccounts(limit)
+  console.log("new joiners", JSON.stringify(users))
+  const filtered = users.filter((u) => !u.is_guest && !u.deactivated)
+
+  if (!filtered.length) {
+    return await sendMessage(client, roomId, "No users found")
+  }
+
+  const lines = filtered
+    .map((u) => {
+      const createdAt = new Date(u.creation_ts).toISOString()
+      return `${u.name}, ${u.displayname ?? ""}, ${createdAt}`
+    })
+    .join("\n")
+
+  return await client.sendHtmlText(roomId, `New joiners (Name, Displayname, CreatedAt):<br/><br/><pre>${lines}</pre>`)
+}