@in.pulse-crm/sdk 2.11.7 → 2.12.0

package/CHANGELOG_READY_MESSAGES.md

@@ -0,0 +1,417 @@
+# 🔄 Changelog - Ready Messages Client
+
+## 📅 Data: 15 de Outubro de 2025
+
+### ✨ Mudanças Implementadas
+
+O `ReadyMessageClient` foi completamente atualizado para refletir a refatoração do backend que migrou de SQL raw para Prisma ORM.
+
+---
+
+## 🔀 Breaking Changes
+
+### 1️⃣ **Tipos Atualizados**
+
+#### ❌ ANTES (Legado)
+```typescript
+interface ReadyMessage {
+  CODIGO: number;
+  TITULO: string;
+  SETOR: number;
+  TEXTO_MENSAGEM: string;
+  ARQUIVO: string;
+  ARQUIVO_CODIGO: string;
+  LAST_UPDATE: Date;
+}
+```
+
+#### ✅ AGORA (Novo)
+```typescript
+interface ReadyMessage {
+  id: number;               // CODIGO → id
+  instance: string;         // NOVO: identificador da instância
+  sectorId: number;         // SETOR → sectorId
+  title: string;            // TITULO → title
+  message: string;          // TEXTO_MENSAGEM → message
+  fileId: number | null;    // ARQUIVO_CODIGO → fileId (agora tipado)
+  fileName: string | null;  // ARQUIVO → fileName
+  onlyAdmin: boolean;       // NOVO: flag para mensagens exclusivas de admin
+  createdAt: Date;          // NOVO: data de criação
+  updatedAt: Date;          // LAST_UPDATE → updatedAt
+}
+```
+
+### 2️⃣ **Assinatura de Métodos**
+
+#### `createReadyMessage()`
+
+##### ❌ ANTES
+```typescript
+await client.createReadyMessage(
+  file,           // File primeiro
+  "Título",       // Parâmetros separados
+  "Mensagem",
+  10
+);
+```
+
+##### ✅ AGORA
+```typescript
+await client.createReadyMessage(
+  {                          // Objeto DTO
+    TITULO: "Título",
+    TEXTO_MENSAGEM: "Mensagem",
+    SETOR: 10,               // Opcional!
+    APENAS_ADMIN: false
+  },
+  file                       // File por último
+);
+```
+
+**Benefícios:**
+- ✅ Parâmetros nomeados (menos erros)
+- ✅ SETOR opcional (usa setor do usuário se omitido)
+- ✅ Suporte a `APENAS_ADMIN`
+
+#### `updateReadyMessage()`
+
+##### ❌ ANTES
+```typescript
+await client.updateReadyMessage(
+  123,
+  entireReadyMessageObject,  // Objeto completo obrigatório
+  file
+);
+```
+
+##### ✅ AGORA
+```typescript
+await client.updateReadyMessage(
+  123,
+  {                           // Apenas campos que quer atualizar
+    TITULO: "Novo Título"
+  },
+  file                        // Opcional
+);
+```
+
+**Benefícios:**
+- ✅ Update parcial (só envia o que mudou)
+- ✅ File opcional
+- ✅ Validação no backend
+
+#### `deleteReadyMessage()`
+
+##### ❌ ANTES
+```typescript
+await client.deleteReadyMessage(chatId);  // Nome confuso
+```
+
+##### ✅ AGORA
+```typescript
+await client.deleteReadyMessage(id);      // Nome correto
+```
+
+---
+
+## 📚 Novos DTOs
+
+### `CreateReadyMessageDto`
+```typescript
+interface CreateReadyMessageDto {
+  TITULO: string;                 // Obrigatório
+  TEXTO_MENSAGEM: string;         // Obrigatório
+  SETOR?: number;                 // Opcional - usa setor do usuário
+  APENAS_ADMIN?: boolean;         // Opcional - padrão: false
+}
+```
+
+### `UpdateReadyMessageDto`
+```typescript
+interface UpdateReadyMessageDto {
+  TITULO?: string;                // Todos opcionais
+  TEXTO_MENSAGEM?: string;
+  APENAS_ADMIN?: boolean;
+}
+```
+
+---
+
+## 🚀 Guia de Migração
+
+### Passo 1: Atualizar Criação
+
+#### ❌ Código Antigo
+```typescript
+const message = await readyMessageClient.createReadyMessage(
+  imageFile,
+  "Mensagem de Boas-vindas",
+  "Olá! Bem-vindo ao nosso atendimento.",
+  10
+);
+```
+
+#### ✅ Código Novo
+```typescript
+const message = await readyMessageClient.createReadyMessage(
+  {
+    TITULO: "Mensagem de Boas-vindas",
+    TEXTO_MENSAGEM: "Olá! Bem-vindo ao nosso atendimento.",
+    SETOR: 10,  // Opcional se usuário estiver em um setor
+    APENAS_ADMIN: false
+  },
+  imageFile  // Pode ser null
+);
+```
+
+### Passo 2: Atualizar Listagem
+
+#### ❌ Código Antigo
+```typescript
+const messages = await readyMessageClient.getReadyMessages();
+
+messages.forEach(msg => {
+  console.log(msg.TITULO);      // UPPERCASE
+  console.log(msg.CODIGO);
+  console.log(msg.SETOR);
+});
+```
+
+#### ✅ Código Novo
+```typescript
+const messages = await readyMessageClient.getReadyMessages();
+
+messages.forEach(msg => {
+  console.log(msg.title);       // camelCase
+  console.log(msg.id);
+  console.log(msg.sectorId);
+  console.log(msg.onlyAdmin);   // Novo campo!
+  console.log(msg.instance);    // Novo campo!
+});
+```
+
+### Passo 3: Atualizar Updates
+
+#### ❌ Código Antigo
+```typescript
+const fullMessage = await readyMessageClient.getReadyMessages();
+const messageToUpdate = fullMessage.find(m => m.CODIGO === 123);
+
+messageToUpdate.TITULO = "Novo Título";
+
+await readyMessageClient.updateReadyMessage(
+  123,
+  messageToUpdate,
+  null
+);
+```
+
+#### ✅ Código Novo
+```typescript
+// Muito mais simples!
+await readyMessageClient.updateReadyMessage(
+  123,
+  { TITULO: "Novo Título" }  // Só o que mudou
+  // file é opcional
+);
+```
+
+### Passo 4: Atualizar Deleção
+
+#### ❌ Código Antigo
+```typescript
+await readyMessageClient.deleteReadyMessage(chatId);
+```
+
+#### ✅ Código Novo
+```typescript
+await readyMessageClient.deleteReadyMessage(messageId);
+```
+
+---
+
+## 🎯 Novos Recursos
+
+### 1. **Mensagens Exclusivas para Admin**
+```typescript
+const adminOnlyMessage = await client.createReadyMessage({
+  TITULO: "Mensagem Interna",
+  TEXTO_MENSAGEM: "Apenas admins veem isso",
+  APENAS_ADMIN: true  // 🔒 Novo!
+});
+```
+
+### 2. **Setor Automático**
+```typescript
+// Se usuário já está em um setor, não precisa informar
+const message = await client.createReadyMessage({
+  TITULO: "Resposta Rápida",
+  TEXTO_MENSAGEM: "Obrigado pelo contato!"
+  // SETOR omitido - usa setor do usuário logado
+});
+```
+
+### 3. **Update Parcial**
+```typescript
+// Atualizar só o título
+await client.updateReadyMessage(123, {
+  TITULO: "Novo Título"
+});
+
+// Atualizar só a mensagem
+await client.updateReadyMessage(123, {
+  TEXTO_MENSAGEM: "Nova mensagem"
+});
+
+// Atualizar apenas flag admin
+await client.updateReadyMessage(123, {
+  APENAS_ADMIN: true
+});
+```
+
+### 4. **Upload Opcional**
+```typescript
+// Sem arquivo
+await client.updateReadyMessage(123, {
+  TITULO: "Atualizado"
+});
+
+// Com arquivo
+await client.updateReadyMessage(123, {
+  TITULO: "Atualizado"
+}, newFile);
+```
+
+---
+
+## 🔒 Melhorias de Segurança
+
+1. ✅ **SQL Injection Eliminado** - Migração para Prisma
+2. ✅ **Validação de Tipos** - TypeScript strict mode
+3. ✅ **Validação de Permissões** - Backend valida setor
+4. ✅ **Sanitização de Dados** - DTOs validados
+
+---
+
+## 📊 Compatibilidade
+
+### Tipo Legado Mantido
+
+Para facilitar migração gradual, o tipo legado ainda está disponível:
+
+```typescript
+import { ReadyMessageLegacy } from './types/ready-messages.types';
+
+// ⚠️ Depreciado - use ReadyMessage
+const oldMessage: ReadyMessageLegacy = {
+  CODIGO: 1,
+  TITULO: "Test",
+  // ...
+};
+```
+
+**Aviso:** `ReadyMessageLegacy` será removido na v3.0.0
+
+---
+
+## 🧪 Exemplos Práticos
+
+### Criar Mensagem Simples
+```typescript
+const client = new ReadyMessageClient("http://localhost:8000");
+client.setAuth(userToken);
+
+const message = await client.createReadyMessage({
+  TITULO: "Horário de Atendimento",
+  TEXTO_MENSAGEM: "Atendemos de segunda a sexta, 8h às 18h",
+});
+
+console.log(`Mensagem criada com ID: ${message.id}`);
+```
+
+### Criar com Arquivo
+```typescript
+const fileInput = document.getElementById('file') as HTMLInputElement;
+const file = fileInput.files?.[0];
+
+const message = await client.createReadyMessage(
+  {
+    TITULO: "Catálogo de Produtos",
+    TEXTO_MENSAGEM: "Confira nosso catálogo em anexo",
+    SETOR: 5
+  },
+  file
+);
+
+console.log(`Arquivo anexado: ${message.fileName}`);
+```
+
+### Listar e Filtrar
+```typescript
+const allMessages = await client.getReadyMessages();
+
+// Filtrar apenas mensagens de admin
+const adminMessages = allMessages.filter(m => m.onlyAdmin);
+
+// Filtrar por setor
+const sectorMessages = allMessages.filter(m => m.sectorId === 10);
+
+// Ordenar por título
+const sorted = allMessages.sort((a, b) => 
+  a.title.localeCompare(b.title)
+);
+```
+
+### Atualizar Incrementalmente
+```typescript
+const messageId = 123;
+
+// Primeiro: atualizar título
+await client.updateReadyMessage(messageId, {
+  TITULO: "Título Atualizado"
+});
+
+// Depois: adicionar arquivo
+const newFile = await fetchFileFromSomewhere();
+await client.updateReadyMessage(messageId, {}, newFile);
+
+// Por fim: tornar admin-only
+await client.updateReadyMessage(messageId, {
+  APENAS_ADMIN: true
+});
+```
+
+---
+
+## ❓ FAQ
+
+### Por que os DTOs ainda usam UPPERCASE?
+
+Para manter compatibilidade com o frontend existente que envia dados nesse formato. O controller faz a conversão para camelCase internamente.
+
+### Posso usar os dois formatos?
+
+Não. O backend agora retorna apenas camelCase. Atualize seu código para usar os novos tipos.
+
+### E se eu não quiser especificar o setor?
+
+Não precisa! Se omitido, o backend usa automaticamente o setor do usuário logado (exceto TI que pode escolher).
+
+### Como sei se meu usuário é TI?
+
+Usuários do setor 3 são considerados TI e podem criar mensagens para qualquer setor.
+
+---
+
+## 📞 Suporte
+
+Dúvidas sobre a migração? 
+- Consulte `docs/refatoracao-ready-messages.md` no whatsapp-service
+- Veja os testes em `src/services/ready-messages.service.spec.ts`
+
+---
+
+**Versão do SDK:** 3.0.0  
+**Data de Release:** 15/10/2025  
+**Breaking Changes:** Sim  
+**Migration Guide:** Este documento

package/MIGRATION_CAMELCASE.md

@@ -0,0 +1,292 @@
+# 🚀 Ready Messages Client - Migração para camelCase
+
+## 📋 Resumo das Mudanças
+
+Os DTOs do Ready Messages Client foram atualizados para usar **camelCase em inglês** seguindo as melhores práticas do TypeScript/JavaScript.
+
+---
+
+## 🔄 DTOs Atualizados
+
+### ✅ Novos DTOs (camelCase)
+
+```typescript
+// CreateReadyMessageDto
+interface CreateReadyMessageDto {
+  title: string;           // "Título da mensagem"
+  message: string;         // "Conteúdo da mensagem"
+  sectorId?: number;       // "ID do setor (opcional)"
+  onlyAdmin?: boolean;     // "Apenas para admin (opcional)"
+}
+
+// UpdateReadyMessageDto  
+interface UpdateReadyMessageDto {
+  title?: string;          // "Novo título (opcional)"
+  message?: string;        // "Nova mensagem (opcional)"
+  onlyAdmin?: boolean;     // "Flag admin (opcional)"
+}
+```
+
+### 🔄 Conversão Automática
+
+O client **automaticamente converte** camelCase para o formato que o backend espera:
+
+```typescript
+// Input (camelCase - novo)
+{
+  title: "Horário",
+  message: "8h às 18h",
+  sectorId: 10,
+  onlyAdmin: true
+}
+
+// ↓ Conversão automática ↓
+
+// Output (UPPERCASE - backend)
+{
+  TITULO: "Horário",
+  TEXTO_MENSAGEM: "8h às 18h", 
+  SETOR: 10,
+  APENAS_ADMIN: true
+}
+```
+
+---
+
+## 📝 Guia de Migração
+
+### Antes (UPPERCASE)
+```typescript
+// ❌ Formato antigo
+await client.createReadyMessage({
+  TITULO: "Mensagem de Boas-vindas",
+  TEXTO_MENSAGEM: "Olá! Bem-vindo!",
+  SETOR: 10,
+  APENAS_ADMIN: false
+});
+
+await client.updateReadyMessage(123, {
+  TITULO: "Novo Título",
+  TEXTO_MENSAGEM: "Nova mensagem"
+});
+```
+
+### Agora (camelCase)
+```typescript
+// ✅ Formato novo
+await client.createReadyMessage({
+  title: "Mensagem de Boas-vindas",
+  message: "Olá! Bem-vindo!",
+  sectorId: 10,
+  onlyAdmin: false
+});
+
+await client.updateReadyMessage(123, {
+  title: "Novo Título",
+  message: "Nova mensagem"
+});
+```
+
+---
+
+## 🛠️ Mapeamento de Campos
+
+| Antigo (UPPERCASE) | Novo (camelCase) | Tipo | Descrição |
+|-------------------|------------------|------|-----------|
+| `TITULO` | `title` | `string` | Título da mensagem |
+| `TEXTO_MENSAGEM` | `message` | `string` | Conteúdo da mensagem |
+| `SETOR` | `sectorId` | `number?` | ID do setor (opcional) |
+| `APENAS_ADMIN` | `onlyAdmin` | `boolean?` | Flag para admin (opcional) |
+
+---
+
+## 💡 Exemplos Práticos
+
+### 1. Criar Mensagem Simples
+```typescript
+const message = await client.createReadyMessage({
+  title: "Horário de Funcionamento",
+  message: "Funcionamos de segunda a sexta, das 8h às 18h"
+});
+```
+
+### 2. Criar Mensagem com Arquivo
+```typescript
+const message = await client.createReadyMessage({
+  title: "Catálogo 2025",
+  message: "Confira nosso novo catálogo em anexo",
+  sectorId: 5,
+  onlyAdmin: false
+}, fileObject);
+```
+
+### 3. Criar Mensagem Apenas para Admin
+```typescript
+const adminMessage = await client.createReadyMessage({
+  title: "Procedimento Interno",
+  message: "Instruções confidenciais para administradores",
+  onlyAdmin: true  // 🔒 Só admins veem
+});
+```
+
+### 4. Atualização Parcial
+```typescript
+// Atualizar apenas o título
+await client.updateReadyMessage(123, {
+  title: "Título Atualizado"
+});
+
+// Atualizar apenas a mensagem
+await client.updateReadyMessage(123, {
+  message: "Mensagem atualizada com novas informações"
+});
+
+// Tornar mensagem exclusiva para admin
+await client.updateReadyMessage(123, {
+  onlyAdmin: true
+});
+```
+
+### 5. Com Upload de Arquivo
+```typescript
+const updatedMessage = await client.updateReadyMessage(
+  123,
+  {
+    title: "Manual Atualizado",
+    message: "Nova versão do manual em anexo"
+  },
+  newFileObject
+);
+```
+
+---
+
+## 🎯 Benefícios
+
+### ✅ Consistência
+- Segue padrões TypeScript/JavaScript
+- Alinhado com conventions modernas
+- Melhor legibilidade do código
+
+### ✅ IntelliSense Melhorado  
+```typescript
+// Auto-complete mostra:
+data.title     // ✅ Claro e conciso
+data.message   // ✅ Descritivo
+data.sectorId  // ✅ Tipado como number
+
+// Ao invés de:
+data.TITULO           // ❌ GRITANDO
+data.TEXTO_MENSAGEM   // ❌ Verboso
+data.SETOR           // ❌ Ambíguo
+```
+
+### ✅ Melhor Manutenibilidade
+- Nomes em inglês facilitam colaboração internacional
+- camelCase é padrão do ecossistema JS/TS
+- Menos confusão entre frontend e backend
+
+---
+
+## 🔄 Compatibilidade
+
+### DTOs Legados Disponíveis
+
+Para facilitar migração gradual, os tipos antigos ainda estão disponíveis:
+
+```typescript
+import { 
+  CreateReadyMessageDtoLegacy,
+  UpdateReadyMessageDtoLegacy 
+} from './types/ready-messages.types';
+
+// ⚠️ Depreciado - migre para os novos DTOs
+const oldData: CreateReadyMessageDtoLegacy = {
+  TITULO: "Test",
+  TEXTO_MENSAGEM: "Test message"
+};
+```
+
+**⚠️ Aviso:** DTOs legados serão removidos na versão 4.0.0
+
+---
+
+## 🧪 Testando a Migração
+
+### Teste Básico
+```typescript
+import ReadyMessageClient from '@in.pulse-crm/sdk';
+
+const client = new ReadyMessageClient('http://localhost:8000');
+client.setAuth(token);
+
+// Teste de criação
+const message = await client.createReadyMessage({
+  title: "Teste de Migração",
+  message: "Se você está lendo isso, a migração funcionou! 🎉"
+});
+
+console.log('✅ Migração bem-sucedida!');
+console.log('ID da mensagem:', message.id);
+console.log('Título:', message.title);
+```
+
+### Teste com Todos os Campos
+```typescript
+const fullTest = await client.createReadyMessage({
+  title: "Teste Completo",
+  message: "Testando todos os campos disponíveis",
+  sectorId: 10,
+  onlyAdmin: true
+}, null);
+
+// Teste de atualização
+const updated = await client.updateReadyMessage(fullTest.id, {
+  title: "Título Atualizado",
+  onlyAdmin: false
+});
+
+console.log('✅ Teste completo bem-sucedido!');
+```
+
+---
+
+## ❓ FAQ
+
+### P: Preciso alterar o backend?
+**R:** Não! O client faz a conversão automaticamente. O backend continua recebendo UPPERCASE.
+
+### P: E se eu usar os campos antigos por engano?
+**R:** TypeScript mostrará erro de compilação. Isso evita bugs em produção.
+
+### P: Posso misturar formatos antigos e novos?
+**R:** Não recomendado. Use apenas os novos DTOs para consistência.
+
+### P: Como saber se estou usando a versão correta?
+**R:** Verifique se seus DTOs usam `title`, `message`, `sectorId`, `onlyAdmin`.
+
+---
+
+## 🎓 Resumo
+
+### O que mudou:
+- ✅ DTOs agora usam camelCase em inglês
+- ✅ Conversão automática para backend
+- ✅ Melhor IntelliSense e documentação
+- ✅ Compatibilidade mantida temporariamente
+
+### O que você precisa fazer:
+1. Atualizar seus DTOs para camelCase
+2. Testar a integração
+3. Remover referências aos DTOs legados
+
+### Deadline:
+- **Migração recomendada:** Imediatamente
+- **DTOs legados removidos:** Versão 4.0.0
+
+---
+
+**Versão:** 3.1.0  
+**Data:** 15/10/2025  
+**Breaking Changes:** Não (compatibilidade mantida)  
+**Próxima versão:** DTOs legados serão removidos