@agenus-io/pixel-backend-sdk 1.0.18

package/README.md

@@ -0,0 +1,350 @@
+# Pixel SDK
+
+SDK completo para gerenciamento de pixels e envio de vendas para fila AWS SQS do micro-serviço de pixels (Meta/Facebook, Google, TikTok).
+
+## Instalação
+
+```bash
+npm install @davidpimentabenony/pixel-sdk
+# ou
+yarn add @davidpimentabenony/pixel-sdk
+# ou
+pnpm add @davidpimentabenony/pixel-sdk
+```
+
+## Funcionalidades
+
+Este SDK fornece duas funcionalidades principais:
+
+1. **Gerenciamento de Pixels**: CRUD completo de pixels (Create, Update, Delete, Get, GetOne)
+2. **Envio de Vendas**: Envio de pedidos/vendas para processamento via AWS SQS
+
+## Uso
+
+### Configuração Inicial
+
+```typescript
+import { PixelSDK } from "@davidpimentabenony/pixel-sdk";
+import type { AWSConfig, Order } from "@davidpimentabenony/pixel-sdk";
+
+// Configure o SDK com suas credenciais AWS e credenciais da aplicação
+const config: AWSConfig = {
+  region: "us-east-1",
+  accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
+  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
+  queueUrl: process.env.QUEUE_SALES_URL!,
+};
+
+const appId = process.env.APP_ID!;
+const appToken = process.env.APP_TOKEN!;
+
+const sdk = new PixelSDK(config, appId, appToken);
+```
+
+### 1. Enviar Vendas para a Fila
+
+```typescript
+const order: Order = {
+  dispatch: "META", // "META", "GOOGLE" ou "TIKTOK"
+  event: "PURCHASE_COMPLETED", // ou "PURCHASE_PENDING"
+  checkout: "cartpanda",
+  orderId: "ORD-123456",
+  subscriptionId: "SUB-789012", // opcional
+  currency: "BRL",
+  valueGross: 347.0,
+  valueNet: 329.9,
+  createdAt: new Date(),
+  
+  // Pixel IDs (opcional, dependendo da plataforma)
+  fbc: "fb.1.1733718123.uYhGtFdSLoPqWeRtYuIo", // Meta/Facebook
+  fbp: "fb.1.1733718123.4455667788", // Meta/Facebook
+  fbclid: "fbclid-value", // Meta/Facebook
+  gclid: "Cj0KCQi...", // Google
+  gbraid: "gbraid-value", // Google
+  wbraid: "wbraid-value", // Google
+  
+  customer: {
+    email: "cliente@example.com",
+    externalId: "USR-123", // opcional
+    firstName: "João",
+    lastName: "Silva",
+    phone: "+55 11 99999-9999", // opcional
+    city: "São Paulo", // opcional
+    state: "SP", // opcional
+    zipCode: "01310-100", // opcional
+    country: "BR", // opcional
+    ip: "189.45.201.77", // opcional
+    userAgent: "Mozilla/5.0...", // opcional
+  },
+  
+  products: [
+    {
+      id: "PROD-001",
+      title: "Produto 1",
+      externalId: "EXT-001",
+      quantity: 2,
+    },
+    {
+      id: "PROD-002",
+      title: "Produto 2",
+      externalId: "EXT-002",
+      quantity: 1,
+    },
+  ],
+};
+
+try {
+  await sdk.SendOrder({
+    workspaceId: "workspace-123",
+    order,
+  });
+  console.log("Venda enviada com sucesso!");
+} catch (error) {
+  console.error("Erro ao enviar venda:", error);
+}
+```
+
+### 2. Gerenciar Pixels
+
+#### Criar Pixel
+
+```typescript
+await sdk.Create({
+  workspaceId: "workspace-123",
+  data: {
+    title: "Pixel Meta",
+    status: true,
+    sendLead: true,
+    sendLeadText: "Lead capturado",
+    addToCart: true,
+    addToCartText: "Produto adicionado ao carrinho",
+    initiateCheckout: true,
+    initiateCheckoutDetection: "AUTOMATIC",
+    initiateCheckoutDetectionText: undefined,
+    purchaseSendType: "SALES_APPROVED",
+    purchaseValueType: "SALE_VALUE",
+    type: "META",
+    productIds: ["prod-1", "prod-2"],
+    sendIp: "IPV6_AND_IPV4",
+    pixelMeta: [
+      {
+        id: "pixel-id-123",
+        title: "Pixel Principal",
+        token: "pixel-token-123",
+      },
+    ],
+  },
+});
+```
+
+#### Listar Pixels
+
+```typescript
+const result = await sdk.Get({
+  workSpaceId: "workspace-123",
+  page: 1,
+  pageSize: 10,
+  filter: undefined, // opcional
+});
+
+console.log(result.data); // Array de pixels
+console.log(result.meta); // Metadados de paginação
+```
+
+#### Buscar um Pixel Específico
+
+```typescript
+const result = await sdk.GetOne({
+  id: "pixel-id-123",
+  workSpaceId: "workspace-123",
+});
+
+console.log(result.data); // Dados do pixel ou null
+```
+
+#### Atualizar Pixel
+
+```typescript
+await sdk.Update({
+  id: "pixel-id-123",
+  workspaceId: "workspace-123",
+  data: {
+    title: "Pixel Atualizado",
+    status: false,
+    // Apenas os campos que deseja atualizar
+  },
+});
+```
+
+#### Deletar Pixel
+
+```typescript
+await sdk.Delete({
+  id: "pixel-id-123",
+  workspaceId: "workspace-123",
+});
+```
+
+## Tipos Exportados
+
+### `MarketingPlatform`
+```typescript
+type MarketingPlatform = "GOOGLE" | "META" | "TIKTOK";
+```
+
+### `PurchaseEventType`
+```typescript
+type PurchaseEventType = "PURCHASE_PENDING" | "PURCHASE_COMPLETED";
+```
+
+### `PurchaseSendType`
+```typescript
+type PurchaseSendType = "SALES_APPROVED" | "SALES_APPROVED_AND_PENDING";
+```
+
+### `PurchaseValueType`
+```typescript
+type PurchaseValueType = "SALE_VALUE" | "COMMISSION";
+```
+
+### `InitiateCheckoutDetection`
+```typescript
+type InitiateCheckoutDetection = "AUTOMATIC" | "CONTAINS_TEXT" | "CONTAINS_CSS" | "CONTAINS_URL";
+```
+
+### `SendIp`
+```typescript
+type SendIp = "IPV6_AND_IPV4" | "ONLY_IPV6" | "DONT_SEND";
+```
+
+### `Order`
+Estrutura completa de dados da venda (veja exemplo acima).
+
+### `AWSConfig`
+Configuração necessária para conexão com AWS SQS:
+- `region`: string - Região AWS
+- `accessKeyId`: string - Access Key ID
+- `secretAccessKey`: string - Secret Access Key
+- `queueUrl`: string - URL da fila SQS
+
+### `SendSaleParams`
+Parâmetros para envio de venda:
+- `workspaceId`: string - ID do workspace
+- `order`: Order - Dados da venda/pedido
+
+## Variáveis de Ambiente
+
+As credenciais AWS e da aplicação devem ser fornecidas ao instanciar o SDK. Recomendamos usar variáveis de ambiente:
+
+```env
+AWS_REGION=us-east-1
+AWS_ACCESS_KEY_ID=AKIA...
+AWS_SECRET_ACCESS_KEY=secret...
+QUEUE_SALES_URL=https://sqs.us-east-1.amazonaws.com/123456789012/queue-name
+APP_ID=your-app-id
+APP_TOKEN=your-app-token
+```
+
+## Exemplo Completo
+
+```typescript
+import { PixelSDK } from "@davidpimentabenony/pixel-sdk";
+import type { AWSConfig, Order } from "@davidpimentabenony/pixel-sdk";
+
+// 1. Configurar SDK
+const config: AWSConfig = {
+  region: process.env.AWS_REGION!,
+  accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
+  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
+  queueUrl: process.env.QUEUE_SALES_URL!,
+};
+
+const sdk = new PixelSDK(
+  config,
+  process.env.APP_ID!,
+  process.env.APP_TOKEN!
+);
+
+// 2. Mapear venda do seu sistema para o formato do SDK
+function mapOrderToSDKFormat(order: YourOrderType): Order {
+  return {
+    dispatch: order.platform, // "META", "GOOGLE", ou "TIKTOK"
+    event: order.status === "completed" ? "PURCHASE_COMPLETED" : "PURCHASE_PENDING",
+    checkout: order.checkoutProvider,
+    orderId: order.id,
+    currency: order.currency,
+    valueGross: order.total,
+    valueNet: order.subtotal,
+    createdAt: order.createdAt,
+    customer: {
+      email: order.customer.email,
+      firstName: order.customer.firstName,
+      lastName: order.customer.lastName,
+      phone: order.customer.phone,
+      // ... outros campos opcionais
+    },
+    products: order.items.map(item => ({
+      id: item.productId,
+      title: item.title,
+      externalId: item.externalId,
+      quantity: item.quantity,
+    })),
+  };
+}
+
+// 3. Enviar venda
+async function handleOrderCompleted(order: YourOrderType, workspaceId: string) {
+  const orderData = mapOrderToSDKFormat(order);
+  
+  try {
+    await sdk.SendOrder({
+      workspaceId,
+      order: orderData,
+    });
+    console.log(`Venda ${order.id} enviada com sucesso!`);
+  } catch (error) {
+    console.error(`Erro ao enviar venda ${order.id}:`, error);
+    // Implemente sua lógica de retry ou notificação aqui
+  }
+}
+
+// 4. Exemplo de uso completo com gerenciamento de pixels
+async function exemploCompleto() {
+  // Listar pixels
+  const pixels = await sdk.Get({
+    workSpaceId: "workspace-123",
+    page: 1,
+    pageSize: 10,
+  });
+  
+  console.log(`Total de pixels: ${pixels.meta.total}`);
+  
+  // Enviar uma venda
+  await handleOrderCompleted(myOrder, "workspace-123");
+}
+```
+
+## Manutenção
+
+Quando houver atualizações no SDK:
+
+1. A versão será atualizada no npm
+2. Atualize o pacote nos seus apps: `npm update @davidpimentabenony/pixel-sdk`
+3. Se houver breaking changes, serão documentados nas release notes
+
+## Segurança
+
+⚠️ **IMPORTANTE**: Nunca commite credenciais AWS ou tokens de aplicação no código fonte. Sempre use variáveis de ambiente ou serviços de gerenciamento de segredos (AWS Secrets Manager, etc).
+
+## API de Pixels
+
+O SDK se conecta à API de pixels hospedada em: `https://micro-servico-pixel-develop.up.railway.app`
+
+Todas as operações CRUD de pixels utilizam autenticação via headers:
+- `app-id`: ID da aplicação
+- `app-secret-token`: Token secreto da aplicação
+- `work-space-id`: ID do workspace
+
+## Suporte
+
+Para questões ou problemas, abra uma issue no repositório do projeto.

package/dist/Class/index.d.ts

@@ -0,0 +1,30 @@
+import type { AWSConfig, SendSaleParams } from "../config";
+import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk } from './interface';
+/**
+ * Classe responsável por com vendas e pixels
+ */
+export declare class PixelSDK implements IPixelSdk {
+    private sqs;
+    private queueUrl;
+    private appId;
+    private appToken;
+    private apiUrl;
+    /**
+     * Constrói uma instância do SDK com as credenciais AWS
+     * @param config Configuração AWS (credenciais e URL da fila)
+     * @param appId ID da aplicação
+     * @param appToken Token da aplicação
+     */
+    constructor(config: AWSConfig, appId: string, appToken: string);
+    /**
+     * Envia uma venda para a fila AWS SQS
+     * @param params Parâmetros contendo os dados da venda
+     * @throws {Error} Se houver erro ao enviar a mensagem para a fila
+     */
+    SendOrder(params: SendSaleParams): Promise<void>;
+    Create({ data, workspaceId }: ICreatePixelDTO.Params): Promise<void>;
+    Update({ data, workspaceId, id }: IUpdatePixelDTO.Params): Promise<void>;
+    Delete({ id, workspaceId }: IDeletePixelDTO.Params): Promise<void>;
+    Get({ page, pageSize, filter, workSpaceId }: IGetPixelDTO.Params): Promise<IGetPixelDTO.Result>;
+    GetOne({ id, workSpaceId }: IGetOnePixelDTO.Params): Promise<IGetOnePixelDTO.Result>;
+}

package/dist/Class/index.js

@@ -0,0 +1,201 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PixelSDK = void 0;
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+const axios_1 = __importStar(require("axios"));
+/**
+ * Classe responsável por com vendas e pixels
+ */
+class PixelSDK {
+    /**
+     * Constrói uma instância do SDK com as credenciais AWS
+     * @param config Configuração AWS (credenciais e URL da fila)
+     * @param appId ID da aplicação
+     * @param appToken Token da aplicação
+     */
+    constructor(config, appId, appToken) {
+        this.queueUrl = config.queueUrl;
+        this.appId = appId;
+        this.appToken = appToken;
+        this.apiUrl = "https://micro-servico-pixel-develop.up.railway.app";
+        this.sqs = new aws_sdk_1.default.SQS({
+            region: config.region,
+            credentials: {
+                accessKeyId: config.accessKeyId,
+                secretAccessKey: config.secretAccessKey,
+            },
+        });
+    }
+    /**
+     * Envia uma venda para a fila AWS SQS
+     * @param params Parâmetros contendo os dados da venda
+     * @throws {Error} Se houver erro ao enviar a mensagem para a fila
+     */
+    async SendOrder(params) {
+        const { workspaceId, order } = params;
+        try {
+            await this.sqs
+                .sendMessage({
+                QueueUrl: this.queueUrl,
+                MessageBody: JSON.stringify({
+                    body: {
+                        workspaceId,
+                        order,
+                        app: {
+                            id: this.appId,
+                            token: this.appToken,
+                        }
+                    },
+                }),
+            })
+                .promise();
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Erro desconhecido ao enviar venda";
+            throw new Error(`Falha ao enviar venda para a fila: ${errorMessage}`);
+        }
+    }
+    async Create({ data, workspaceId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workspaceId,
+            };
+            await axios_1.default.post(`${this.apiUrl}/pixels`, { token, ...data });
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao criar pixel";
+        }
+    }
+    async Update({ data, workspaceId, id }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workspaceId,
+            };
+            await axios_1.default.put(`${this.apiUrl}/pixels/${id}`, { token, ...data });
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao atualizar pixel";
+        }
+    }
+    async Delete({ id, workspaceId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workspaceId,
+            };
+            await axios_1.default.delete(`${this.apiUrl}/pixels/${id}`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+            });
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao deletar pixel";
+        }
+    }
+    async Get({ page, pageSize, filter, workSpaceId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/pixels`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { page, pageSize, filter },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao deletar pixel";
+        }
+    }
+    async GetOne({ id, workSpaceId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/pixels/${id}`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+            });
+            return {
+                data: response.data,
+            };
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao deletar pixel";
+        }
+    }
+}
+exports.PixelSDK = PixelSDK;

package/dist/Class/interface.d.ts

@@ -0,0 +1,143 @@
+import { InitiateCheckoutDetection, MarketingPlatform, PurchaseSendType, PurchaseValueType, SendIp } from '../types';
+interface CreatePixel {
+    title: string;
+    status: boolean;
+    sendLead: boolean;
+    sendLeadText?: string;
+    addToCart: boolean;
+    addToCartText?: string;
+    initiateCheckout: boolean;
+    initiateCheckoutDetection: InitiateCheckoutDetection;
+    initiateCheckoutDetectionText?: string;
+    purchaseSendType: PurchaseSendType;
+    purchaseValueType: PurchaseValueType;
+    type: MarketingPlatform;
+    productIds: string[];
+    sendIp: SendIp;
+    pixelMeta?: {
+        id: string;
+        title?: string;
+        token: string;
+    }[];
+    pixelTikTok?: {
+        id: string;
+        title?: string;
+        token: string;
+    }[];
+    pixelGoogle?: {
+        id: string;
+        title?: string;
+        token: string;
+        customerId: string;
+    }[];
+}
+export declare namespace ICreatePixelDTO {
+    type Params = {
+        workspaceId: string;
+        data: CreatePixel;
+    };
+}
+export declare namespace IUpdatePixelDTO {
+    type Params = {
+        id: string;
+        workspaceId: string;
+        data: Partial<CreatePixel>;
+    };
+}
+export declare namespace IDeletePixelDTO {
+    type Params = {
+        id: string;
+        workspaceId: string;
+    };
+}
+export declare namespace IGetPixelDTO {
+    type Params = {
+        workSpaceId: string;
+        page: number;
+        pageSize: number;
+        filter?: string;
+    };
+    type Result = {
+        data: {
+            productIds: string[];
+            id: string;
+            code: string;
+            title: string;
+            createdAt: Date;
+            status: boolean;
+            type: MarketingPlatform;
+            sendLead: boolean;
+            sendLeadText: string | null;
+            addToCart: boolean;
+            addToCartText: string | null;
+            initiateCheckout: boolean;
+            initiateCheckoutDetection: InitiateCheckoutDetection;
+            initiateCheckoutDetectionText: string | null;
+            purchaseSendType: PurchaseSendType;
+            purchaseValueType: PurchaseValueType;
+            sendIp: SendIp;
+        }[];
+        meta: {
+            total: number;
+            totalPages: number;
+            page: number;
+            pageSize: number;
+        };
+    };
+}
+export declare namespace IGetOnePixelDTO {
+    type Params = {
+        id: string;
+        workSpaceId: string;
+    };
+    type Result = {
+        data: {
+            productIds: string[];
+            pixelTikTok: {
+                id: string;
+                title?: string;
+                token: string;
+                externalId: string;
+            }[];
+            pixelGoogle: {
+                select: {
+                    id: true;
+                    title?: string;
+                    token: true;
+                    customerId: true;
+                    resourceName: true;
+                };
+            };
+            pixelMeta: {
+                id: string;
+                title?: string;
+                token: string;
+                externalId: string;
+            }[];
+            id: string;
+            code: string;
+            title: string;
+            createdAt: Date;
+            status: boolean;
+            type: MarketingPlatform;
+            sendLead: boolean;
+            sendLeadText: string | null;
+            addToCart: boolean;
+            addToCartText: string | null;
+            initiateCheckout: boolean;
+            initiateCheckoutDetection: InitiateCheckoutDetection;
+            initiateCheckoutDetectionText: string | null;
+            purchaseSendType: PurchaseSendType;
+            purchaseValueType: PurchaseValueType;
+            sendIp: SendIp;
+        } | null;
+    };
+}
+export interface IPixelSdk {
+    Create(params: ICreatePixelDTO.Params): Promise<void>;
+    Update(params: IUpdatePixelDTO.Params): Promise<void>;
+    Delete(params: IDeletePixelDTO.Params): Promise<void>;
+    Get(params: IGetPixelDTO.Params): Promise<IGetPixelDTO.Result>;
+    GetOne(params: IGetOnePixelDTO.Params): Promise<IGetOnePixelDTO.Result>;
+}
+export {};

package/dist/Class/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config.d.ts

@@ -0,0 +1,34 @@
+import type { Order } from "./types";
+/**
+ * Configuração de credenciais AWS para conexão com SQS
+ */
+export interface AWSConfig {
+    /**
+     * Região AWS onde a fila SQS está localizada
+     * Exemplo: "us-east-1", "sa-east-1"
+     */
+    region: string;
+    /**
+     * Access Key ID da AWS
+     */
+    accessKeyId: string;
+    /**
+     * Secret Access Key da AWS
+     */
+    secretAccessKey: string;
+    /**
+     * URL da fila SQS
+     * Exemplo: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"
+     */
+    queueUrl: string;
+}
+/**
+ * Parâmetros para envio de mensagem
+ */
+export interface SendSaleParams {
+    /**
+     * Dados da venda a serem enviados
+     */
+    workspaceId: string;
+    order: Order;
+}

package/dist/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * SDK para envio de vendas para fila AWS SQS
+ *
+ * Este pacote permite que aplicações clientes enviem vendas
+ * para o micro-serviço de pixels através de uma fila AWS SQS.
+ */
+export type { AWSConfig, SendSaleParams } from "./config";
+export { PixelSDK } from "./Class";
+export type { InitiateCheckoutDetection, MarketingPlatform, PurchaseEventType, PurchaseSendType, PurchaseValueType, SendIp, Order, } from "./types";
+export { InitiateCheckoutDetectionEnum, PurchaseValueTypeEnum, MarketingPlatformEnum, PurchaseEventTypeEnum, PurchaseSendTypeEnum, SendIpEnum, } from "./types";

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * SDK para envio de vendas para fila AWS SQS
+ *
+ * Este pacote permite que aplicações clientes enviem vendas
+ * para o micro-serviço de pixels através de uma fila AWS SQS.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendIpEnum = exports.PurchaseSendTypeEnum = exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.PurchaseValueTypeEnum = exports.InitiateCheckoutDetectionEnum = exports.PixelSDK = void 0;
+var Class_1 = require("./Class");
+Object.defineProperty(exports, "PixelSDK", { enumerable: true, get: function () { return Class_1.PixelSDK; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "InitiateCheckoutDetectionEnum", { enumerable: true, get: function () { return types_1.InitiateCheckoutDetectionEnum; } });
+Object.defineProperty(exports, "PurchaseValueTypeEnum", { enumerable: true, get: function () { return types_1.PurchaseValueTypeEnum; } });
+Object.defineProperty(exports, "MarketingPlatformEnum", { enumerable: true, get: function () { return types_1.MarketingPlatformEnum; } });
+Object.defineProperty(exports, "PurchaseEventTypeEnum", { enumerable: true, get: function () { return types_1.PurchaseEventTypeEnum; } });
+Object.defineProperty(exports, "PurchaseSendTypeEnum", { enumerable: true, get: function () { return types_1.PurchaseSendTypeEnum; } });
+Object.defineProperty(exports, "SendIpEnum", { enumerable: true, get: function () { return types_1.SendIpEnum; } });

package/dist/sendSale.d.ts

@@ -0,0 +1,52 @@
+import type { AWSConfig, SendSaleParams } from "./config";
+import type { Order } from "./types";
+/**
+ * Classe responsável por enviar vendas para a fila AWS SQS
+ */
+export declare class PixelSDK {
+    private sqs;
+    private queueUrl;
+    private appId;
+    private appToken;
+    /**
+     * Constrói uma instância do SDK com as credenciais AWS
+     * @param config Configuração AWS (credenciais e URL da fila)
+     */
+    constructor(config: AWSConfig, appId: string, appToken: string);
+    /**
+     * Envia uma venda para a fila AWS SQS
+     * @param params Parâmetros contendo os dados da venda
+     * @throws {Error} Se houver erro ao enviar a mensagem para a fila
+     */
+    sendSale(params: SendSaleParams): Promise<void>;
+    /**
+     * Envia múltiplas vendas para a fila (usa batch quando possível)
+     * @param sales Array de dados de vendas
+     * @throws {Error} Se houver erro ao enviar as mensagens
+     */
+    sendSales(workspaceId: string, orders: Order[]): Promise<void>;
+}
+/**
+ * Função helper para criar uma instância do SDK e enviar uma venda
+ * Útil para uso direto sem precisar instanciar a classe
+ *
+ * @param config Configuração AWS
+ * @param sale Dados da venda
+ * @example
+ * ```typescript
+ * await sendSaleToQueue(
+ *   {
+ *     region: "us-east-1",
+ *     accessKeyId: "AKIA...",
+ *     secretAccessKey: "secret...",
+ *     queueUrl: "https://sqs..."
+ *   },
+ *   {
+ *     workspaceId: "123",
+ *     app: { id: "app-id", token: "token" },
+ *     order: { ... }
+ *   }
+ * );
+ * ```
+ */
+export declare function sendSaleToQueue(config: AWSConfig, workspaceId: string, appId: string, appToken: string, order: Order): Promise<void>;

package/dist/sendSale.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PixelSDK = void 0;
+exports.sendSaleToQueue = sendSaleToQueue;
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+/**
+ * Classe responsável por enviar vendas para a fila AWS SQS
+ */
+class PixelSDK {
+    /**
+     * Constrói uma instância do SDK com as credenciais AWS
+     * @param config Configuração AWS (credenciais e URL da fila)
+     */
+    constructor(config, appId, appToken) {
+        this.queueUrl = config.queueUrl;
+        this.appId = appId;
+        this.appToken = appToken;
+        this.sqs = new aws_sdk_1.default.SQS({
+            region: config.region,
+            credentials: {
+                accessKeyId: config.accessKeyId,
+                secretAccessKey: config.secretAccessKey,
+            },
+        });
+    }
+    /**
+     * Envia uma venda para a fila AWS SQS
+     * @param params Parâmetros contendo os dados da venda
+     * @throws {Error} Se houver erro ao enviar a mensagem para a fila
+     */
+    async sendSale(params) {
+        const { workspaceId, order } = params;
+        try {
+            await this.sqs
+                .sendMessage({
+                QueueUrl: this.queueUrl,
+                MessageBody: JSON.stringify({
+                    body: {
+                        workspaceId,
+                        order,
+                        appId: this.appId,
+                        appToken: this.appToken,
+                    },
+                }),
+            })
+                .promise();
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Erro desconhecido ao enviar venda";
+            throw new Error(`Falha ao enviar venda para a fila: ${errorMessage}`);
+        }
+    }
+    /**
+     * Envia múltiplas vendas para a fila (usa batch quando possível)
+     * @param sales Array de dados de vendas
+     * @throws {Error} Se houver erro ao enviar as mensagens
+     */
+    async sendSales(workspaceId, orders) {
+        const promises = orders.map((order) => this.sendSale({ workspaceId, order }));
+        await Promise.all(promises);
+    }
+}
+exports.PixelSDK = PixelSDK;
+/**
+ * Função helper para criar uma instância do SDK e enviar uma venda
+ * Útil para uso direto sem precisar instanciar a classe
+ *
+ * @param config Configuração AWS
+ * @param sale Dados da venda
+ * @example
+ * ```typescript
+ * await sendSaleToQueue(
+ *   {
+ *     region: "us-east-1",
+ *     accessKeyId: "AKIA...",
+ *     secretAccessKey: "secret...",
+ *     queueUrl: "https://sqs..."
+ *   },
+ *   {
+ *     workspaceId: "123",
+ *     app: { id: "app-id", token: "token" },
+ *     order: { ... }
+ *   }
+ * );
+ * ```
+ */
+async function sendSaleToQueue(config, workspaceId, appId, appToken, order) {
+    const sdk = new PixelSDK(config, appId, appToken);
+    await sdk.sendSale({ workspaceId, order });
+}

package/dist/types.d.ts

@@ -0,0 +1,50 @@
+export type InitiateCheckoutDetection = "AUTOMATIC" | "CONTAINS_TEXT" | "CONTAINS_CSS" | "CONTAINS_URL";
+export type PurchaseSendType = "SALES_APPROVED" | "SALES_APPROVED_AND_PENDING";
+export type PurchaseEventType = "PURCHASE_PENDING" | "PURCHASE_COMPLETED";
+export type SendIp = "IPV6_AND_IPV4" | "ONLY_IPV6" | "DONT_SEND";
+export type MarketingPlatform = "GOOGLE" | "META" | "TIKTOK";
+export type PurchaseValueType = "SALE_VALUE" | "COMMISSION";
+export declare const InitiateCheckoutDetectionEnum: Record<InitiateCheckoutDetection, InitiateCheckoutDetection>;
+export declare const PurchaseSendTypeEnum: Record<PurchaseSendType, PurchaseSendType>;
+export declare const PurchaseValueTypeEnum: Record<PurchaseValueType, PurchaseValueType>;
+export declare const SendIpEnum: Record<SendIp, SendIp>;
+export declare const MarketingPlatformEnum: Record<MarketingPlatform, MarketingPlatform>;
+export declare const PurchaseEventTypeEnum: Record<PurchaseEventType, PurchaseEventType>;
+export interface CustomerData {
+    email: string;
+    externalId?: string;
+    firstName: string;
+    lastName: string;
+    phone?: string;
+    city?: string;
+    state?: string;
+    zipCode?: string;
+    country?: string;
+    ip?: string;
+    userAgent?: string;
+}
+export interface ProductData {
+    id: string;
+    title: string;
+    externalId: string;
+    quantity: number;
+}
+export interface Order {
+    dispatch: MarketingPlatform;
+    event: PurchaseEventType;
+    checkout: string;
+    orderId: string;
+    subscriptionId?: string;
+    fbc?: string;
+    fbp?: string;
+    fbclid?: string;
+    gclid?: string;
+    gbraid?: string;
+    wbraid?: string;
+    currency: string;
+    valueGross: number;
+    valueNet: number;
+    createdAt: Date;
+    customer: CustomerData;
+    products: ProductData[];
+}

package/dist/types.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.SendIpEnum = exports.PurchaseValueTypeEnum = exports.PurchaseSendTypeEnum = exports.InitiateCheckoutDetectionEnum = void 0;
+exports.InitiateCheckoutDetectionEnum = {
+    AUTOMATIC: "AUTOMATIC",
+    CONTAINS_TEXT: "CONTAINS_TEXT",
+    CONTAINS_CSS: "CONTAINS_CSS",
+    CONTAINS_URL: "CONTAINS_URL",
+};
+exports.PurchaseSendTypeEnum = {
+    SALES_APPROVED: "SALES_APPROVED",
+    SALES_APPROVED_AND_PENDING: "SALES_APPROVED_AND_PENDING",
+};
+exports.PurchaseValueTypeEnum = {
+    SALE_VALUE: "SALE_VALUE",
+    COMMISSION: "COMMISSION",
+};
+exports.SendIpEnum = {
+    IPV6_AND_IPV4: "IPV6_AND_IPV4",
+    ONLY_IPV6: "ONLY_IPV6",
+    DONT_SEND: "DONT_SEND",
+};
+exports.MarketingPlatformEnum = {
+    META: "META",
+    GOOGLE: "GOOGLE",
+    TIKTOK: "TIKTOK",
+};
+exports.PurchaseEventTypeEnum = {
+    PURCHASE_PENDING: "PURCHASE_PENDING",
+    PURCHASE_COMPLETED: "PURCHASE_COMPLETED",
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@agenus-io/pixel-backend-sdk",
+  "version": "1.0.18",
+  "description": "SDK para envio de vendas para fila AWS SQS do micro-serviço de pixels",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "pixel",
+    "aws",
+    "sqs",
+    "sales",
+    "facebook",
+    "google",
+    "tiktok"
+  ],
+  "author": "David",
+  "license": "ISC",
+  "dependencies": {
+    "aws-sdk": "^2.1692.0",
+    "axios": "^1.13.2"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "typescript": "^5.9.2"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ]
+}