feat: SMS campaigns for people or leads with filters and batching

Add audience tabs, province/city filters, select-all ids, dynamic SMS tokens, and 50-sized create/send chunks.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-10-17 20:54:32 +03:30
co-authored by Cursor
parent 32c722f42a
commit d62e004e90
10 changed files with 1040 additions and 131 deletions
@@ -8,6 +8,7 @@ import {
UseGuards,
} from '@nestjs/common';
import {
ArrayMaxSize,
IsArray,
IsBoolean,
IsDateString,
@@ -21,12 +22,14 @@ import {
ValidateIf,
} from 'class-validator';
import { Type } from 'class-transformer';
import { SMS_CAMPAIGN_CHUNK_SIZE } from '@mento/shared';
import { JwtAuthGuard } from '../auth/jwt-auth.guard';
import { CurrentUser } from '../auth/current-user.decorator';
import { Roles } from '../auth/roles.decorator';
import { RolesGuard } from '../auth/roles.guard';
import { OrgModuleGuard } from '../billing/org-module.guard';
import { RequireOrgModule } from '../billing/org-module.decorator';
import type { Actor } from '../common/record-scope';
import { SmsCampaignsService } from './sms-campaigns.service';
class CreateSmsCampaignDto {
@@ -40,9 +43,17 @@ class CreateSmsCampaignDto {
@MaxLength(900)
body!: string;
@IsOptional()
@IsArray()
@ArrayMaxSize(SMS_CAMPAIGN_CHUNK_SIZE)
@IsString({ each: true })
personIds!: string[];
personIds?: string[];
@IsOptional()
@IsArray()
@ArrayMaxSize(SMS_CAMPAIGN_CHUNK_SIZE)
@IsString({ each: true })
leadIds?: string[];
@IsOptional()
@ValidateIf((_, v) => v !== '' && v != null)
@@ -54,6 +65,20 @@ class CreateSmsCampaignDto {
queueNow?: boolean;
}
class AddRecipientsDto {
@IsOptional()
@IsArray()
@ArrayMaxSize(SMS_CAMPAIGN_CHUNK_SIZE)
@IsString({ each: true })
personIds?: string[];
@IsOptional()
@IsArray()
@ArrayMaxSize(SMS_CAMPAIGN_CHUNK_SIZE)
@IsString({ each: true })
leadIds?: string[];
}
class ListQueryDto {
@IsOptional()
@Type(() => Number)
@@ -105,19 +130,17 @@ export class SmsCampaignsController {
}
@Post()
create(
@CurrentUser()
user: { organizationId: string; userId: string; role: string },
@Body() dto: CreateSmsCampaignDto,
create(@CurrentUser() user: Actor, @Body() dto: CreateSmsCampaignDto) {
return this.campaigns.create(user, dto);
}
@Post(':id/recipients')
addRecipients(
@CurrentUser() user: Actor,
@Param('id') id: string,
@Body() dto: AddRecipientsDto,
) {
return this.campaigns.create(
{
organizationId: user.organizationId,
userId: user.userId,
role: user.role as 'owner' | 'admin' | 'sales' | 'support',
},
dto,
);
return this.campaigns.addRecipients(user, id, dto);
}
@Post(':id/queue')
@@ -5,6 +5,7 @@ import {
} from '@nestjs/common';
import { Cron } from '@nestjs/schedule';
import type {
AddSmsCampaignRecipientsRequest,
CreateSmsCampaignRequest,
SmsCampaignClickerDto,
SmsCampaignDto,
@@ -12,10 +13,32 @@ import type {
SmsCampaignReportDto,
SmsCampaignStatus,
} from '@mento/shared';
import { SMS_CAMPAIGN_CHUNK_SIZE } from '@mento/shared';
import { PrismaService } from '../prisma/prisma.service';
import { SmsService } from '../common/sms.service';
import { type Actor, ownerWhere } from '../common/record-scope';
import { renderSmsText } from '../common/sms-text';
import {
type Actor,
elevated,
forScope,
ownerWhere,
} from '../common/record-scope';
import { TrackingService } from '../tracking/tracking.service';
import type { Prisma } from '@prisma/client';
function leadAccessWhere(baseActor: Actor): Prisma.LeadWhereInput {
const actor = forScope(baseActor, 'leads');
if (elevated(actor.role)) return {};
if (actor.dataVisibility === 'org') return {};
if (
actor.dataVisibility === 'team' &&
actor.visibleUserIds &&
actor.visibleUserIds.length
) {
return { assigneeId: { in: actor.visibleUserIds } };
}
return { assigneeId: actor.userId };
}
@Injectable()
export class SmsCampaignsService {
@@ -230,19 +253,24 @@ export class SmsCampaignsService {
throw new BadRequestException('متن پیامک کوتاه است');
}
const personIds = [...new Set((dto.personIds ?? []).filter(Boolean))];
if (!personIds.length) {
const leadIds = [...new Set((dto.leadIds ?? []).filter(Boolean))];
if (personIds.length && leadIds.length) {
throw new BadRequestException('کمپین نمی‌تواند همزمان شخص و لید داشته باشد.');
}
if (!personIds.length && !leadIds.length) {
throw new BadRequestException('حداقل یک مخاطب انتخاب کنید');
}
if (personIds.length > SMS_CAMPAIGN_CHUNK_SIZE || leadIds.length > SMS_CAMPAIGN_CHUNK_SIZE) {
throw new BadRequestException(
`حداکثر ${SMS_CAMPAIGN_CHUNK_SIZE} مخاطب در هر درخواست مجاز است.`,
);
}
const people = await this.prisma.person.findMany({
where: {
id: { in: personIds },
organizationId: actor.organizationId,
...ownerWhere(actor),
},
select: { id: true, mobile: true },
});
if (!people.length) throw new BadRequestException('مخاطب معتبری پیدا نشد');
const recipients =
personIds.length > 0
? await this.resolvePersonRecipients(actor, personIds)
: await this.resolveLeadRecipients(actor, leadIds);
if (!recipients.length) throw new BadRequestException('مخاطب معتبری پیدا نشد');
const queueNow = Boolean(dto.queueNow);
const scheduledAt = dto.scheduledAt ? new Date(dto.scheduledAt) : null;
@@ -252,6 +280,7 @@ export class SmsCampaignsService {
const status: SmsCampaignStatus =
queueNow || scheduledAt ? 'queued' : 'draft';
const skipped = recipients.filter((r) => !r.mobile).length;
const campaign = await this.prisma.smsCampaign.create({
data: {
@@ -260,27 +289,143 @@ export class SmsCampaignsService {
body,
status,
scheduledAt: queueNow ? new Date() : scheduledAt,
totalCount: people.length,
totalCount: recipients.length,
skippedCount: skipped,
createdById: actor.userId,
recipients: {
create: people.map((p) => ({
personId: p.id,
mobile: p.mobile,
status: p.mobile ? 'pending' : 'skipped',
create: recipients.map((r) => ({
personId: r.personId,
leadId: r.leadId,
mobile: r.mobile,
status: r.mobile ? 'pending' : 'skipped',
})),
},
},
});
const skipped = people.filter((p) => !p.mobile).length;
if (skipped) {
await this.prisma.smsCampaign.update({
where: { id: campaign.id },
data: { skippedCount: skipped },
});
return this.get(actor.organizationId, campaign.id);
}
async addRecipients(
actor: Actor,
campaignId: string,
dto: AddSmsCampaignRecipientsRequest,
): Promise<SmsCampaignDto> {
const campaign = await this.prisma.smsCampaign.findFirst({
where: { id: campaignId, organizationId: actor.organizationId },
});
if (!campaign) throw new NotFoundException('کمپین پیدا نشد');
if (campaign.status !== 'draft' && campaign.status !== 'cancelled') {
throw new BadRequestException('فقط به کمپین پیش‌نویس می‌توان مخاطب افزود.');
}
return this.get(actor.organizationId, campaign.id);
const personIds = [...new Set((dto.personIds ?? []).filter(Boolean))];
const leadIds = [...new Set((dto.leadIds ?? []).filter(Boolean))];
if (personIds.length && leadIds.length) {
throw new BadRequestException('در هر درخواست فقط شخص یا فقط لید بفرستید.');
}
if (!personIds.length && !leadIds.length) {
throw new BadRequestException('حداقل یک مخاطب انتخاب کنید');
}
if (personIds.length > SMS_CAMPAIGN_CHUNK_SIZE || leadIds.length > SMS_CAMPAIGN_CHUNK_SIZE) {
throw new BadRequestException(
`حداکثر ${SMS_CAMPAIGN_CHUNK_SIZE} مخاطب در هر درخواست مجاز است.`,
);
}
const existingSample = await this.prisma.smsCampaignRecipient.findFirst({
where: { campaignId },
select: { personId: true, leadId: true },
});
if (existingSample?.personId && leadIds.length) {
throw new BadRequestException('این کمپین فقط برای اشخاص است.');
}
if (existingSample?.leadId && personIds.length) {
throw new BadRequestException('این کمپین فقط برای لیدها است.');
}
const resolved =
personIds.length > 0
? await this.resolvePersonRecipients(actor, personIds)
: await this.resolveLeadRecipients(actor, leadIds);
const existingIds = new Set(
(
await this.prisma.smsCampaignRecipient.findMany({
where: { campaignId },
select: { personId: true, leadId: true },
})
).map((r) => r.personId ?? r.leadId ?? ''),
);
const fresh = resolved.filter(
(r) => !existingIds.has(r.personId ?? r.leadId ?? ''),
);
if (!fresh.length) {
return this.get(actor.organizationId, campaignId);
}
const skipped = fresh.filter((r) => !r.mobile).length;
await this.prisma.smsCampaignRecipient.createMany({
data: fresh.map((r) => ({
campaignId,
personId: r.personId,
leadId: r.leadId,
mobile: r.mobile,
status: r.mobile ? 'pending' : 'skipped',
})),
});
await this.prisma.smsCampaign.update({
where: { id: campaignId },
data: {
totalCount: { increment: fresh.length },
skippedCount: { increment: skipped },
status: 'draft',
},
});
return this.get(actor.organizationId, campaignId);
}
private async resolvePersonRecipients(
actor: Actor,
personIds: string[],
): Promise<
Array<{ personId: string; leadId: null; mobile: string | null }>
> {
const people = await this.prisma.person.findMany({
where: {
id: { in: personIds },
organizationId: actor.organizationId,
...ownerWhere(actor),
},
select: { id: true, mobile: true },
});
return people.map((p) => ({
personId: p.id,
leadId: null,
mobile: p.mobile?.trim() || null,
}));
}
private async resolveLeadRecipients(
actor: Actor,
leadIds: string[],
): Promise<
Array<{ personId: null; leadId: string; mobile: string | null }>
> {
const leads = await this.prisma.lead.findMany({
where: {
id: { in: leadIds },
organizationId: actor.organizationId,
archivedAt: null,
...leadAccessWhere(actor),
},
select: { id: true, mobile: true },
});
return leads.map((l) => ({
personId: null,
leadId: l.id,
mobile: l.mobile?.trim() || null,
}));
}
async queue(organizationId: string, id: string): Promise<SmsCampaignDto> {
@@ -350,10 +495,44 @@ export class SmsCampaignsService {
const batch = await this.prisma.smsCampaignRecipient.findMany({
where: { campaignId, status: 'pending' },
take: 40,
take: SMS_CAMPAIGN_CHUNK_SIZE,
orderBy: { createdAt: 'asc' },
});
const personIds = batch
.map((r) => r.personId)
.filter((id): id is string => Boolean(id));
const leadIds = batch
.map((r) => r.leadId)
.filter((id): id is string => Boolean(id));
const [people, leads] = await Promise.all([
personIds.length
? this.prisma.person.findMany({
where: { id: { in: personIds } },
select: {
id: true,
firstName: true,
lastName: true,
mobile: true,
company: { select: { name: true } },
},
})
: Promise.resolve([]),
leadIds.length
? this.prisma.lead.findMany({
where: { id: { in: leadIds } },
select: {
id: true,
title: true,
contactName: true,
mobile: true,
},
})
: Promise.resolve([]),
]);
const personMap = new Map(people.map((p) => [p.id, p]));
const leadMap = new Map(leads.map((l) => [l.id, l]));
let sent = 0;
let failed = 0;
let skipped = 0;
@@ -368,6 +547,27 @@ export class SmsCampaignsService {
continue;
}
let name = '';
let title = '';
let company = '';
if (recipient.personId) {
const p = personMap.get(recipient.personId);
name = [p?.firstName, p?.lastName].filter(Boolean).join(' ').trim();
title = name;
company = p?.company?.name ?? '';
} else if (recipient.leadId) {
const l = leadMap.get(recipient.leadId);
name = (l?.contactName || l?.title || '').trim();
title = (l?.title || name).trim();
}
const withTokens = renderSmsText(campaign.body, {
name,
phone: recipient.mobile,
title,
company,
});
const personalized = await this.tracking.personalizeSmsBody({
organizationId: campaign.organizationId,
channel: 'sms',
@@ -378,7 +578,7 @@ export class SmsCampaignsService {
smsRecipientId: recipient.id,
personId: recipient.personId,
leadId: recipient.leadId,
body: campaign.body,
body: withTokens,
});
const result = await this.sms.sendSmsDetailed(