feat: add support for user lookup by Telegram ID and email

kastov · kastov · commit e1d33cd6df0e · 2025-03-01T22:12:29.000+03:00
- Added new routes and methods to find users by Telegram ID and email
- Updated users schema to include telegramId and email fields
- Implemented repository methods for unique user field lookups
- Enhanced users service to support fetching users by Telegram ID or email
- Updated contract library version to 0.2.0
diff --git a/libs/contract/api/controllers/users.ts b/libs/contract/api/controllers/users.ts
@@ -16,4 +16,6 @@ export const USERS_ROUTES = {
     BULK: {
         DELETE_BY_STATUS: 'bulk/delete-by-status',
     },
+    GET_BY_TELEGRAM_ID: 'tg',
+    GET_BY_EMAIL: 'email',
 } as const;
diff --git a/libs/contract/api/routes.ts b/libs/contract/api/routes.ts
@@ -68,6 +68,10 @@ export const REST_API = {
         BULK: {
             DELETE_BY_STATUS: `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.BULK.DELETE_BY_STATUS}`,
         },
+        GET_BY_TELEGRAM_ID: (telegramId: string) =>
+            `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.GET_BY_TELEGRAM_ID}/${telegramId}`,
+        GET_BY_EMAIL: (email: string) =>
+            `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.GET_BY_EMAIL}/${email}`,
     },
     SUBSCRIPTION: {
         GET: (shortUuid: string) =>
diff --git a/libs/contract/commands/users/create-user.command.ts b/libs/contract/commands/users/create-user.command.ts
@@ -105,6 +105,10 @@ export namespace CreateUserCommand {
             .describe('Date format: 2025-01-17T15:38:45.065Z')
             .optional(),
         description: z.string().optional(),
+
+        telegramId: z.number().optional(),
+        email: z.string().optional(),
+
         activateAllInbounds: z.boolean().optional(),
     });
 
diff --git a/libs/contract/commands/users/get-user-by-email.command.ts b/libs/contract/commands/users/get-user-by-email.command.ts
@@ -0,0 +1,27 @@
+import { z } from 'zod';
+
+import { UsersSchema } from '../../models/users.schema';
+import { REST_API } from '../../api';
+import { LastConnectedNodeSchema } from '../../models';
+
+export namespace GetUserByEmailCommand {
+    export const url = REST_API.USERS.GET_BY_EMAIL;
+    export const TSQ_url = url(':email');
+
+    export const RequestSchema = z.object({
+        email: z.string(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: z.array(
+            UsersSchema.extend({
+                subscriptionUrl: z.string(),
+                lastConnectedNode: LastConnectedNodeSchema,
+            }),
+        ),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}
diff --git a/libs/contract/commands/users/get-user-by-telegram-id.command.ts b/libs/contract/commands/users/get-user-by-telegram-id.command.ts
@@ -0,0 +1,27 @@
+import { z } from 'zod';
+
+import { UsersSchema } from '../../models/users.schema';
+import { REST_API } from '../../api';
+import { LastConnectedNodeSchema } from '../../models';
+
+export namespace GetUserByTelegramIdCommand {
+    export const url = REST_API.USERS.GET_BY_TELEGRAM_ID;
+    export const TSQ_url = url(':telegramId');
+
+    export const RequestSchema = z.object({
+        telegramId: z.string(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: z.array(
+            UsersSchema.extend({
+                subscriptionUrl: z.string(),
+                lastConnectedNode: LastConnectedNodeSchema,
+            }),
+        ),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}
diff --git a/libs/contract/commands/users/index.ts b/libs/contract/commands/users/index.ts
@@ -11,3 +11,5 @@ export * from './reset-user-traffic.command';
 export * from './revoke-user-subscription.command';
 export * from './update-user.command';
 export * from './bulk';
+export * from './get-user-by-telegram-id.command';
+export * from './get-user-by-email.command';
diff --git a/libs/contract/commands/users/update-user.command.ts b/libs/contract/commands/users/update-user.command.ts
@@ -49,6 +49,9 @@ export namespace UpdateUserCommand {
             .describe('Expiration date: 2025-01-17T15:38:45.065Z')
             .optional(),
         description: z.string().optional(),
+
+        telegramId: z.number().optional(),
+        email: z.string().optional(),
     });
 
     export type Request = z.infer<typeof RequestSchema>;
diff --git a/libs/contract/constants/errors/errors.ts b/libs/contract/constants/errors/errors.ts
@@ -306,4 +306,14 @@ export const ERRORS = {
             httpCode: 500,
         }),
     },
+    USERS_NOT_FOUND: {
+        code: 'A062',
+        message: 'Users not found',
+        httpCode: 404,
+    },
+    GET_USER_BY_UNIQUE_FIELDS_NOT_FOUND: {
+        code: 'A063',
+        message: 'User with specified params not found',
+        httpCode: 404,
+    },
 } as const;
diff --git a/libs/contract/models/users.schema.ts b/libs/contract/models/users.schema.ts
@@ -58,6 +58,9 @@ export const UsersSchema = z.object({
 
     description: z.nullable(z.string()),
 
+    telegramId: z.nullable(z.number()),
+    email: z.nullable(z.string()),
+
     createdAt: z
         .string()
         .datetime()
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "0.1.15",
+  "version": "0.2.0",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",
diff --git a/prisma/migrations/20250301181855_add_telegram_id_and_email_fields/migration.sql b/prisma/migrations/20250301181855_add_telegram_id_and_email_fields/migration.sql
@@ -0,0 +1,33 @@
+-- AlterTable
+ALTER TABLE "api_tokens" ALTER COLUMN "created_at" SET DEFAULT now(),
+ALTER COLUMN "updated_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "keygen" ALTER COLUMN "created_at" SET DEFAULT now(),
+ALTER COLUMN "updated_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "nodes" ALTER COLUMN "created_at" SET DEFAULT now(),
+ALTER COLUMN "updated_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "nodes_traffic_usage_history" ALTER COLUMN "reset_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "nodes_usage_history" ALTER COLUMN "created_at" SET DEFAULT date_trunc('hour', now());
+
+-- AlterTable
+ALTER TABLE "nodes_user_usage_history" ALTER COLUMN "created_at" SET DEFAULT date_trunc('hour', now()),
+ALTER COLUMN "updated_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "user_traffic_history" ALTER COLUMN "reset_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "users" ADD COLUMN     "email" TEXT,
+ADD COLUMN     "telegram_id" BIGINT,
+ALTER COLUMN "created_at" SET DEFAULT now(),
+ALTER COLUMN "updated_at" SET DEFAULT now();
+
+-- AlterTable
+ALTER TABLE "xray_config" ALTER COLUMN "updated_at" SET DEFAULT now();
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -37,6 +37,9 @@ model Users {
 
   description String? @map("description")
 
+  telegramId BigInt? @map("telegram_id")
+  email      String? @map("email")
+
   createdAt DateTime @default(dbgenerated("now()")) @map("created_at")
   updatedAt DateTime @default(dbgenerated("now()")) @updatedAt @map("updated_at")
 
diff --git a/src/modules/users/dtos/get-user-by-email.dto.ts b/src/modules/users/dtos/get-user-by-email.dto.ts
@@ -0,0 +1,6 @@
+import { createZodDto } from 'nestjs-zod';
+
+import { GetUserByEmailCommand } from '@libs/contracts/commands';
+
+export class GetUserByEmailRequestDto extends createZodDto(GetUserByEmailCommand.RequestSchema) {}
+export class GetUserByEmailResponseDto extends createZodDto(GetUserByEmailCommand.ResponseSchema) {}
diff --git a/src/modules/users/dtos/get-user-by-telegram-id.dto.ts b/src/modules/users/dtos/get-user-by-telegram-id.dto.ts
@@ -0,0 +1,10 @@
+import { createZodDto } from 'nestjs-zod';
+
+import { GetUserByTelegramIdCommand } from '@libs/contracts/commands';
+
+export class GetUserByTelegramIdRequestDto extends createZodDto(
+    GetUserByTelegramIdCommand.RequestSchema,
+) {}
+export class GetUserByTelegramIdResponseDto extends createZodDto(
+    GetUserByTelegramIdCommand.ResponseSchema,
+) {}
diff --git a/src/modules/users/entities/index.ts b/src/modules/users/entities/index.ts
@@ -2,3 +2,4 @@ export * from './user-with-active-inbounds.entity';
 export * from './user-with-lifetime-traffic.entity';
 export * from './users-for-config';
 export * from './users.entity';
+export * from './user-with-active-inbounds-and-last-connected-node.entity';
diff --git a/src/modules/users/entities/user-with-active-inbounds-and-last-connected-node.entity.ts b/src/modules/users/entities/user-with-active-inbounds-and-last-connected-node.entity.ts
@@ -0,0 +1,33 @@
+import { ILastConnectedNode } from '@modules/nodes-user-usage-history/interfaces';
+import { InboundsEntity } from '../../inbounds/entities/inbounds.entity';
+import { IUserWithActiveInboundsAndLastConnectedNode } from '../interfaces';
+import { UserEntity } from './users.entity';
+
+export class UserWithActiveInboundsAndLastConnectedNodeEntity extends UserEntity {
+    activeUserInbounds: InboundsEntity[];
+    lastConnectedNode: ILastConnectedNode | null;
+
+    constructor(user: Partial<IUserWithActiveInboundsAndLastConnectedNode>) {
+        super(user);
+        if (user.activeUserInbounds) {
+            this.activeUserInbounds = user.activeUserInbounds.map((item) => ({
+                uuid: item.inbound.uuid,
+                tag: item.inbound.tag,
+                type: item.inbound.type,
+                network: item.inbound.network,
+                security: item.inbound.security,
+            }));
+        }
+
+        if (user.nodesUserUsageHistory && user.nodesUserUsageHistory.length > 0) {
+            this.lastConnectedNode = {
+                nodeName: user.nodesUserUsageHistory[0].node.name,
+                connectedAt: user.nodesUserUsageHistory[0].updatedAt,
+            };
+        } else {
+            this.lastConnectedNode = null;
+        }
+
+        return this;
+    }
+}
diff --git a/src/modules/users/entities/user-with-lifetime-traffic.entity.ts b/src/modules/users/entities/user-with-lifetime-traffic.entity.ts
@@ -29,6 +29,9 @@ export class UserWithLifetimeTrafficEntity {
 
     public description: null | string;
 
+    public telegramId: bigint | null;
+    public email: string | null;
+
     public createdAt: Date;
     public updatedAt: Date;
 
diff --git a/src/modules/users/entities/users.entity.ts b/src/modules/users/entities/users.entity.ts
@@ -26,6 +26,8 @@ export class UserEntity implements Users {
     public ssPassword: string;
 
     public description: null | string;
+    public telegramId: bigint | null;
+    public email: string | null;
 
     public createdAt: Date;
     public updatedAt: Date;
diff --git a/src/modules/users/interfaces/get-user-by-unique.interface.ts b/src/modules/users/interfaces/get-user-by-unique.interface.ts
@@ -0,0 +1,6 @@
+export interface IGetUserByUnique {
+    username?: string;
+    subscriptionUuid?: string;
+    uuid?: string;
+    shortUuid?: string;
+}
diff --git a/src/modules/users/interfaces/get-users-by-telegram-id-or-email.interface.ts b/src/modules/users/interfaces/get-users-by-telegram-id-or-email.interface.ts
@@ -0,0 +1,4 @@
+export interface IGetUsersByTelegramIdOrEmail {
+    email?: string;
+    telegramId?: string;
+}
diff --git a/src/modules/users/interfaces/index.ts b/src/modules/users/interfaces/index.ts
@@ -3,3 +3,6 @@ export * from './user-status-count.interface';
 export * from './user-with-active-inbounds.interface';
 export * from './user-with-lifetime-traffic.interface';
 export * from './get-user-with-last-connected-node.interface';
+export * from './user-with-active-inbounds-and-last-connected-node.interface';
+export * from './get-users-by-telegram-id-or-email.interface';
+export * from './get-user-by-unique.interface';
diff --git a/src/modules/users/interfaces/user-with-active-inbounds-and-last-connected-node.interface.ts b/src/modules/users/interfaces/user-with-active-inbounds-and-last-connected-node.interface.ts
@@ -0,0 +1,63 @@
+import { Prisma } from '@prisma/client';
+
+export type IUserWithActiveInboundsAndLastConnectedNode = Prisma.UsersGetPayload<{
+    include: {
+        activeUserInbounds: {
+            select: {
+                inbound: {
+                    select: {
+                        tag: true;
+                        type: true;
+                        uuid: true;
+                        network: true;
+                        security: true;
+                    };
+                };
+            };
+        };
+        nodesUserUsageHistory: {
+            orderBy: {
+                updatedAt: 'desc';
+            };
+            select: {
+                node: {
+                    select: {
+                        name: true;
+                    };
+                };
+                updatedAt: true;
+            };
+            take: 1;
+        };
+    };
+}>;
+
+export const USER_INCLUDE_INBOUNDS_AND_LAST_CONNECTED_NODE = {
+    activeUserInbounds: {
+        select: {
+            inbound: {
+                select: {
+                    uuid: true,
+                    tag: true,
+                    type: true,
+                    network: true,
+                    security: true,
+                },
+            },
+        },
+    },
+    nodesUserUsageHistory: {
+        orderBy: {
+            updatedAt: 'desc',
+        },
+        select: {
+            node: {
+                select: {
+                    name: true,
+                },
+            },
+            updatedAt: true,
+        },
+        take: 1,
+    },
+} as const;
diff --git a/src/modules/users/models/create-user.response.model.ts b/src/modules/users/models/create-user.response.model.ts
@@ -28,6 +28,9 @@ export class CreateUserResponseModel {
     public readonly ssPassword: string;
     public readonly description: null | string;
 
+    public readonly telegramId: number | null;
+    public readonly email: string | null;
+
     public readonly subscriptionUrl: string;
 
     public readonly lastConnectedNode: ILastConnectedNode | null;
@@ -56,6 +59,9 @@ export class CreateUserResponseModel {
         this.ssPassword = entity.ssPassword;
         this.description = entity.description;
 
+        this.telegramId = entity.telegramId ? Number(entity.telegramId) : null;
+        this.email = entity.email;
+
         this.subscriptionUrl = `https://${subPublicDomain}/${entity.shortUuid}`;
         this.lastConnectedNode = null;
     }
diff --git a/src/modules/users/models/get-full-user.response.model.ts b/src/modules/users/models/get-full-user.response.model.ts
diff --git a/src/modules/users/models/get-user.response.model.ts b/src/modules/users/models/get-user.response.model.ts
diff --git a/src/modules/users/models/index.ts b/src/modules/users/models/index.ts
diff --git a/src/modules/users/models/user-with-lf.response.model.ts b/src/modules/users/models/user-with-lf.response.model.ts
diff --git a/src/modules/users/repositories/users.repository.ts b/src/modules/users/repositories/users.repository.ts
diff --git a/src/modules/users/users.controller.ts b/src/modules/users/users.controller.ts
diff --git a/src/modules/users/users.converter.ts b/src/modules/users/users.converter.ts
diff --git a/src/modules/users/users.service.ts b/src/modules/users/users.service.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@remnawave/backend-contract",`
`3`		`- "version": "0.1.15",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"public": true,`
`5`	`5`	`"license": "AGPL-3.0-only",`
`6`	`6`	`"description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",`