tychat-contracts 1.6.21 → 1.6.24

package/src/connections/whatsapp-official.dto.ts

@@ -1,113 +1,113 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
-
-/**
- * Payload to register a WhatsApp Official (Meta Cloud API) instance for a tenant.
- * Requires the access token, phone number ID, and WhatsApp Business Account ID
- * obtained from the Meta developer portal.
- */
-export class CreateWhatsAppOfficialInstanceDto {
-  @ApiProperty({
-    description: 'Meta Cloud API permanent access token',
-    example: 'EAABs...',
-  })
-  @IsString()
-  @IsNotEmpty()
-  accessToken: string;
-
-  @ApiProperty({
-    description: 'Phone Number ID from Meta Business Manager',
-    example: '106540352242922',
-  })
-  @IsString()
-  @IsNotEmpty()
-  phoneNumberId: string;
-
-  @ApiProperty({
-    description: 'WhatsApp Business Account ID (WABA ID)',
-    example: '102291529438901',
-  })
-  @IsString()
-  @IsNotEmpty()
-  wabaId: string;
-
-  @ApiPropertyOptional({
-    description: 'Webhook verify token used to validate Meta webhook registration',
-    example: 'my-verify-token',
-  })
-  @IsOptional()
-  @IsString()
-  webhookVerifyToken?: string;
-}
-
-/**
- * Payload to send a pre-approved template message via WhatsApp Official (Meta Cloud API).
- * Templates must be created and approved in the Meta Business Manager before use.
- */
-export class SendWhatsAppOfficialTemplateDto {
-  @ApiProperty({
-    description: 'Recipient phone number with country code (digits only)',
-    example: '5511999999999',
-  })
-  @IsString()
-  @IsNotEmpty()
-  to: string;
-
-  @ApiProperty({
-    description: 'Approved template name in Meta Business Manager',
-    example: 'appointment_confirmation',
-  })
-  @IsString()
-  @IsNotEmpty()
-  templateName: string;
-
-  @ApiProperty({
-    description: 'Template language code (BCP 47)',
-    example: 'pt_BR',
-  })
-  @IsString()
-  @IsNotEmpty()
-  languageCode: string;
-
-  @ApiPropertyOptional({
-    description:
-      'Template body variable components (positional parameters). ' +
-      'Each element replaces {{1}}, {{2}}, etc. in the template body.',
-    example: ['João', '15/04/2026 às 10:00'],
-    type: [String],
-  })
-  @IsOptional()
-  @IsString({ each: true })
-  bodyParameters?: string[];
-
-  @ApiPropertyOptional({
-    description: 'Template header variable components (positional parameters)',
-    example: ['Clínica Saúde'],
-    type: [String],
-  })
-  @IsOptional()
-  @IsString({ each: true })
-  headerParameters?: string[];
-}
-
-/**
- * Payload to send a free-form text message via WhatsApp Official (Meta Cloud API).
- * Only works within the 24-hour customer service window.
- */
-export class SendWhatsAppOfficialTextDto {
-  @ApiProperty({
-    description: 'Recipient phone number with country code (digits only)',
-    example: '5511999999999',
-  })
-  @IsString()
-  @IsNotEmpty()
-  to: string;
-
-  @ApiProperty({
-    description: 'Plain text message body',
-    example: 'Olá! Tudo bem?',
-  })
-  @IsString()
-  @IsNotEmpty()
-  text: string;
-}
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+/**
+ * Payload to register a WhatsApp Official (Meta Cloud API) instance for a tenant.
+ * Requires the access token, phone number ID, and WhatsApp Business Account ID
+ * obtained from the Meta developer portal.
+ */
+export class CreateWhatsAppOfficialInstanceDto {
+  @ApiProperty({
+    description: 'Meta Cloud API permanent access token',
+    example: 'EAABs...',
+  })
+  @IsString()
+  @IsNotEmpty()
+  accessToken: string;
+
+  @ApiProperty({
+    description: 'Phone Number ID from Meta Business Manager',
+    example: '106540352242922',
+  })
+  @IsString()
+  @IsNotEmpty()
+  phoneNumberId: string;
+
+  @ApiProperty({
+    description: 'WhatsApp Business Account ID (WABA ID)',
+    example: '102291529438901',
+  })
+  @IsString()
+  @IsNotEmpty()
+  wabaId: string;
+
+  @ApiPropertyOptional({
+    description: 'Webhook verify token used to validate Meta webhook registration',
+    example: 'my-verify-token',
+  })
+  @IsOptional()
+  @IsString()
+  webhookVerifyToken?: string;
+}
+
+/**
+ * Payload to send a pre-approved template message via WhatsApp Official (Meta Cloud API).
+ * Templates must be created and approved in the Meta Business Manager before use.
+ */
+export class SendWhatsAppOfficialTemplateDto {
+  @ApiProperty({
+    description: 'Recipient phone number with country code (digits only)',
+    example: '5511999999999',
+  })
+  @IsString()
+  @IsNotEmpty()
+  to: string;
+
+  @ApiProperty({
+    description: 'Approved template name in Meta Business Manager',
+    example: 'appointment_confirmation',
+  })
+  @IsString()
+  @IsNotEmpty()
+  templateName: string;
+
+  @ApiProperty({
+    description: 'Template language code (BCP 47)',
+    example: 'pt_BR',
+  })
+  @IsString()
+  @IsNotEmpty()
+  languageCode: string;
+
+  @ApiPropertyOptional({
+    description:
+      'Template body variable components (positional parameters). ' +
+      'Each element replaces {{1}}, {{2}}, etc. in the template body.',
+    example: ['João', '15/04/2026 às 10:00'],
+    type: [String],
+  })
+  @IsOptional()
+  @IsString({ each: true })
+  bodyParameters?: string[];
+
+  @ApiPropertyOptional({
+    description: 'Template header variable components (positional parameters)',
+    example: ['Clínica Saúde'],
+    type: [String],
+  })
+  @IsOptional()
+  @IsString({ each: true })
+  headerParameters?: string[];
+}
+
+/**
+ * Payload to send a free-form text message via WhatsApp Official (Meta Cloud API).
+ * Only works within the 24-hour customer service window.
+ */
+export class SendWhatsAppOfficialTextDto {
+  @ApiProperty({
+    description: 'Recipient phone number with country code (digits only)',
+    example: '5511999999999',
+  })
+  @IsString()
+  @IsNotEmpty()
+  to: string;
+
+  @ApiProperty({
+    description: 'Plain text message body',
+    example: 'Olá! Tudo bem?',
+  })
+  @IsString()
+  @IsNotEmpty()
+  text: string;
+}

package/src/conversations/conversation-contact-filters-query.validator.spec.ts

@@ -1,221 +1,221 @@
-import 'reflect-metadata';
-import { plainToInstance } from 'class-transformer';
-import { validate } from 'class-validator';
-import { ListConversationContactsQueryDto } from './list-conversation-contacts-query.dto';
-
-/**
- * Simulates how NestJS ValidationPipe processes a raw query object
- * when configured with transform: true and enableImplicitConversion: true.
- */
-function simulateValidationPipe(
-  raw: Record<string, unknown>,
-): ListConversationContactsQueryDto {
-  return plainToInstance(ListConversationContactsQueryDto, raw, {
-    enableImplicitConversion: true,
-  });
-}
-
-describe('ConversationContactFiltersQueryConstraint', () => {
-  it('should accept a single JSON object string (URL-decoded query param)', async () => {
-    const raw = {
-      page: '1',
-      limit: '20',
-      filters: '{"key":"intention","op":"==","value":"clinic_info"}',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toEqual([
-      expect.objectContaining({
-        key: 'intention',
-        op: '==',
-        value: 'clinic_info',
-      }),
-    ]);
-  });
-
-  it('should accept a JSON array string with one filter', async () => {
-    const raw = {
-      page: '1',
-      limit: '20',
-      filters: '[{"key":"intention","op":"==","value":"clinic_info"}]',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(1);
-  });
-
-  it('should accept a JSON array string with multiple filters', async () => {
-    const raw = {
-      filters:
-        '[{"key":"intention","op":"==","value":"clinic_info"},{"key":"patientId","op":"!=","value":"abc"}]',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(2);
-  });
-
-  it('should accept an array of JSON strings (e.g. filters[0]=...&filters[1]=...)', async () => {
-    const raw = {
-      filters: [
-        '{"key":"intention","op":"==","value":"clinic_info"}',
-        '{"key":"patientId","op":"!=","value":"xyz"}',
-      ],
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(2);
-  });
-
-  it('should accept an array of plain objects (Kafka / programmatic usage)', async () => {
-    const raw = {
-      filters: [
-        { key: 'intention', op: '==', value: 'clinic_info' },
-      ],
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(1);
-  });
-
-  it('should accept a single plain object', async () => {
-    const raw = {
-      filters: { key: 'intention', op: '==', value: 'clinic_info' },
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(1);
-  });
-
-  it('should accept undefined/null filters', async () => {
-    const dto = simulateValidationPipe({ page: '1', limit: '20' });
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toBeUndefined();
-  });
-
-  it('should accept sortBy and sortOrder query params', async () => {
-    const dto = simulateValidationPipe({
-      page: '1',
-      limit: '20',
-      sortBy: 'startedAt',
-      sortOrder: 'desc',
-    });
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.sortBy).toBe('startedAt');
-    expect(dto.sortOrder).toBe('DESC');
-  });
-
-  it('should accept empty string filters', async () => {
-    const dto = simulateValidationPipe({ filters: '' });
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toBeUndefined();
-  });
-
-  it('should reject invalid JSON string', async () => {
-    const dto = simulateValidationPipe({ filters: '{bad json' });
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors.length).toBeGreaterThan(0);
-  });
-
-  it('should reject a filter with invalid key', async () => {
-    const raw = {
-      filters: '{"key":"invalidField","op":"==","value":"x"}',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors.length).toBeGreaterThan(0);
-  });
-
-  it('should reject a filter with invalid operator', async () => {
-    const raw = {
-      filters: '{"key":"intention","op":"contains","value":"x"}',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors.length).toBeGreaterThan(0);
-  });
-
-  it('should accept op "in" with array value', async () => {
-    const raw = {
-      filters: '{"key":"intention","op":"in","value":["clinic_info","other"]}',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-  });
-
-  it('should reject op "in" with scalar value', async () => {
-    const raw = {
-      filters: '{"key":"intention","op":"in","value":"clinic_info"}',
-    };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors.length).toBeGreaterThan(0);
-  });
-
-  it('should handle double-encoded JSON string', async () => {
-    const inner = JSON.stringify({
-      key: 'intention',
-      op: '==',
-      value: 'clinic_info',
-    });
-    const raw = { filters: JSON.stringify(inner) };
-    const dto = simulateValidationPipe(raw);
-    const errors = await validate(dto, {
-      whitelist: true,
-      forbidNonWhitelisted: true,
-    });
-    expect(errors).toHaveLength(0);
-    expect(dto.filters).toHaveLength(1);
-  });
-});
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { ListConversationContactsQueryDto } from './list-conversation-contacts-query.dto';
+
+/**
+ * Simulates how NestJS ValidationPipe processes a raw query object
+ * when configured with transform: true and enableImplicitConversion: true.
+ */
+function simulateValidationPipe(
+  raw: Record<string, unknown>,
+): ListConversationContactsQueryDto {
+  return plainToInstance(ListConversationContactsQueryDto, raw, {
+    enableImplicitConversion: true,
+  });
+}
+
+describe('ConversationContactFiltersQueryConstraint', () => {
+  it('should accept a single JSON object string (URL-decoded query param)', async () => {
+    const raw = {
+      page: '1',
+      limit: '20',
+      filters: '{"key":"intention","op":"==","value":"clinic_info"}',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toEqual([
+      expect.objectContaining({
+        key: 'intention',
+        op: '==',
+        value: 'clinic_info',
+      }),
+    ]);
+  });
+
+  it('should accept a JSON array string with one filter', async () => {
+    const raw = {
+      page: '1',
+      limit: '20',
+      filters: '[{"key":"intention","op":"==","value":"clinic_info"}]',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(1);
+  });
+
+  it('should accept a JSON array string with multiple filters', async () => {
+    const raw = {
+      filters:
+        '[{"key":"intention","op":"==","value":"clinic_info"},{"key":"patientId","op":"!=","value":"abc"}]',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(2);
+  });
+
+  it('should accept an array of JSON strings (e.g. filters[0]=...&filters[1]=...)', async () => {
+    const raw = {
+      filters: [
+        '{"key":"intention","op":"==","value":"clinic_info"}',
+        '{"key":"patientId","op":"!=","value":"xyz"}',
+      ],
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(2);
+  });
+
+  it('should accept an array of plain objects (Kafka / programmatic usage)', async () => {
+    const raw = {
+      filters: [
+        { key: 'intention', op: '==', value: 'clinic_info' },
+      ],
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(1);
+  });
+
+  it('should accept a single plain object', async () => {
+    const raw = {
+      filters: { key: 'intention', op: '==', value: 'clinic_info' },
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(1);
+  });
+
+  it('should accept undefined/null filters', async () => {
+    const dto = simulateValidationPipe({ page: '1', limit: '20' });
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toBeUndefined();
+  });
+
+  it('should accept sortBy and sortOrder query params', async () => {
+    const dto = simulateValidationPipe({
+      page: '1',
+      limit: '20',
+      sortBy: 'startedAt',
+      sortOrder: 'desc',
+    });
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.sortBy).toBe('startedAt');
+    expect(dto.sortOrder).toBe('DESC');
+  });
+
+  it('should accept empty string filters', async () => {
+    const dto = simulateValidationPipe({ filters: '' });
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toBeUndefined();
+  });
+
+  it('should reject invalid JSON string', async () => {
+    const dto = simulateValidationPipe({ filters: '{bad json' });
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors.length).toBeGreaterThan(0);
+  });
+
+  it('should reject a filter with invalid key', async () => {
+    const raw = {
+      filters: '{"key":"invalidField","op":"==","value":"x"}',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors.length).toBeGreaterThan(0);
+  });
+
+  it('should reject a filter with invalid operator', async () => {
+    const raw = {
+      filters: '{"key":"intention","op":"contains","value":"x"}',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors.length).toBeGreaterThan(0);
+  });
+
+  it('should accept op "in" with array value', async () => {
+    const raw = {
+      filters: '{"key":"intention","op":"in","value":["clinic_info","other"]}',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+  });
+
+  it('should reject op "in" with scalar value', async () => {
+    const raw = {
+      filters: '{"key":"intention","op":"in","value":"clinic_info"}',
+    };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors.length).toBeGreaterThan(0);
+  });
+
+  it('should handle double-encoded JSON string', async () => {
+    const inner = JSON.stringify({
+      key: 'intention',
+      op: '==',
+      value: 'clinic_info',
+    });
+    const raw = { filters: JSON.stringify(inner) };
+    const dto = simulateValidationPipe(raw);
+    const errors = await validate(dto, {
+      whitelist: true,
+      forbidNonWhitelisted: true,
+    });
+    expect(errors).toHaveLength(0);
+    expect(dto.filters).toHaveLength(1);
+  });
+});