sunat-engine-nest 2.0.0 → 2.0.1

package/README.md

@@ -1,30 +1,8 @@
 # sunat-engine-nest
 
-![npm](https://img.shields.io/npm/v/sunat-engine-nest)
-![license](https://img.shields.io/npm/l/sunat-engine-nest)
-
 Motor de Facturación Electrónica SUNAT UBL 2.1 para NestJS.
 
-Soporta Facturas, Boletas, Notas de Crédito/Débito, Guías de Remisión (GRE), Resúmenes Diarios y Comunicaciones de Baja — firma XML, envío a SUNAT/OSE, parseo de CDR y generación de PDF.
-
-## Índice
-
-- [Instalación](#instalación)
-- [Configuración](#configuración)
-  - [Registro síncrono](#registro-síncrono)
-  - [Registro asíncrono](#registro-asíncrono)
-  - [Proveedor: SUNAT directo vs OSE](#proveedor-sunat-directo-vs-ose)
-  - [Certificado digital](#certificado-digital)
-  - [Variables de entorno](#variables-de-entorno)
-- [Uso](#uso)
-  - [Enviar un comprobante](#enviar-un-comprobante)
-  - [Documentos soportados](#documentos-soportados)
-- [Generación de PDF (función paga)](#generación-de-pdf-función-paga)
-- [Testing / Modo simulado](#testing--modo-simulado)
-- [Respuesta del motor](#respuesta-del-motor)
-- [Endpoints SUNAT](#endpoints-sunat)
-- [Soporte y actualizaciones](#soporte-y-actualizaciones)
-- [Licencia](#licencia)
+Soporta Facturas, Boletas, Notas de Crédito/Débito, Guías de Remisión (GRE), Resúmenes Diarios y Comunicaciones de Baja.
 
 ## Instalación
 
@@ -38,11 +16,10 @@ pnpm add sunat-engine-nest
 
 Registra el módulo en tu `AppModule`. Puedes definir las credenciales de tu empresa **una sola vez** en el módulo usando el campo `sunat`, evitando repetirlas en cada llamada.
 
-### Registro síncrono
-
 ```typescript
 import { SunatEngineModule } from 'sunat-engine-nest';
 
+// Registro síncrono
 @Module({
   imports: [
     SunatEngineModule.forRoot({
@@ -65,14 +42,11 @@ import { SunatEngineModule } from 'sunat-engine-nest';
 export class AppModule {}
 ```
 
-### Registro asíncrono
-
-Recomendado cuando las credenciales dependen de variables de entorno.
-
 ```typescript
 import { SunatEngineModule } from 'sunat-engine-nest';
 import { ConfigModule, ConfigService } from '@nestjs/config';
 
+// Registro asíncrono (recomendado con variables de entorno)
 @Module({
   imports: [
     ConfigModule.forRoot({ isGlobal: true }),
@@ -105,7 +79,29 @@ import { ConfigModule, ConfigService } from '@nestjs/config';
 export class AppModule {}
 ```
 
-### Proveedor: SUNAT directo vs OSE
+## Variables de entorno
+
+```env
+# Credenciales SUNAT
+SUNAT_RUC=20123456789
+SUNAT_SOL_USER=MODDATOS
+SUNAT_SOL_PASS=moddatos
+SUNAT_CERT_PEM=BASE64_DEL_P12
+SUNAT_MODE=beta
+
+# GRE (Guía de Remisión Electrónica)
+GRE_AUTH_URL=https://gre-test.nubefact.com/v1
+GRE_API_URL=https://gre-test.nubefact.com/v1
+GRE_CLIENT_ID=tu_client_id
+GRE_CLIENT_SECRET=tu_client_secret
+
+# OSE (solo si provider=ose)
+PROVIDER=ose
+OSE_URL=https://api.tuose.com/v1/documents
+OSE_TOKEN=tu_token_aqui
+```
+
+## Proveedor: SUNAT directo vs OSE
 
 Puedes elegir enviar tus comprobantes **directamente a SUNAT** o a través de un **OSE (Operador de Servicios Electrónicos)** autorizado como Nubefact, EFACT, DigiFlow, Bizlinks, entre otros.
 
@@ -132,7 +128,7 @@ SunatEngineModule.forRoot({
 
 > El `OseClient` es genérico y compatible con cualquier OSE que acepte `{ fileName, contentFile }` (ZIP en base64) vía POST con autenticación Bearer o Basic.
 
-### Certificado digital
+## Certificado digital
 
 El motor acepta el certificado en tres formatos:
 
@@ -154,32 +150,8 @@ const credentials: CompanyCredentials = {
 };
 ```
 
-### Variables de entorno
-
-```env
-# Credenciales SUNAT
-SUNAT_RUC=20123456789
-SUNAT_SOL_USER=MODDATOS
-SUNAT_SOL_PASS=moddatos
-SUNAT_CERT_PEM=BASE64_DEL_P12
-SUNAT_MODE=beta
-
-# GRE (Guía de Remisión Electrónica)
-GRE_AUTH_URL=https://gre-test.nubefact.com/v1
-GRE_API_URL=https://gre-test.nubefact.com/v1
-GRE_CLIENT_ID=tu_client_id
-GRE_CLIENT_SECRET=tu_client_secret
-
-# OSE (solo si provider=ose)
-PROVIDER=ose
-OSE_URL=https://api.tuose.com/v1/documents
-OSE_TOKEN=tu_token_aqui
-```
-
 ## Uso
 
-### Enviar un comprobante
-
 Inyecta `SunatEngineService` en cualquier servicio o controlador. Si configuraste `sunat:{}` en el módulo, **no necesitas pasar credenciales en cada llamada**:
 
 ```typescript
@@ -250,85 +222,18 @@ return this.engine.sendInvoice(payload, {
 });
 ```
 
-### Documentos soportados
-
-| Tipo | Método de envío | Descripción | PDF |
-|------|------------------|-------------|-----|
-| Factura (01) | `sendInvoice()` | Factura electrónica — SOAP síncrono | ✅ `generateInvoice()` |
-| Boleta (03) | `sendInvoice()` | Boleta de venta electrónica — SOAP síncrono | ✅ `generateInvoice()` |
-| Nota de Crédito (07) | `sendNote()` | NC electrónica — SOAP síncrono | ✅ `generateNote()` |
-| Nota de Débito (08) | `sendNote()` | ND electrónica — SOAP síncrono | ✅ `generateNote()` |
-| Guía de Remisión (09) | `sendDespatch()` | GRE 2022 — REST/OAuth asíncrono | ✅ `generateDespatch()` |
-| Resumen Diario (RC) | `sendSummary()` | Resumen de boletas — SOAP asíncrono | — (comunicación interna a SUNAT) |
-| Comunicación de Baja (RA) | `sendVoided()` | Baja de comprobantes — SOAP asíncrono | — (comunicación interna a SUNAT) |
-| Consulta de ticket | `getTicketStatus()` | Estado de procesos asíncronos | — |
-
-## Generación de PDF (función paga)
-
-El envío a SUNAT (XML, firma, CDR, GRE) sigue siendo **MIT / gratuito**. La generación de PDF es una función **paga**: necesitas una license key para usarla — [escríbeme por WhatsApp](https://wa.me/51907596305) para adquirir una.
-
-La licencia se valida **localmente** (firma Ed25519), sin llamadas a ningún servidor externo — tus datos de facturación nunca salen de tu infraestructura.
-
-```typescript
-SunatEngineModule.forRoot({
-  sunat: { ruc: '...', solUser: '...', solPass: '...', certPem: '...' },
-  pdf: {
-    licenseKey: 'LA_LICENSE_KEY_QUE_TE_ENTREGO', // o desde tu ConfigService/env
-  },
-})
-```
-
-```typescript
-import { DocumentPdfService } from 'sunat-engine-nest';
-
-@Injectable()
-export class InvoicesService {
-  constructor(
-    private readonly engine: SunatEngineService,
-    private readonly pdf: DocumentPdfService,
-  ) {}
-
-  async getPdf(payload: InvoicePayload): Promise<Buffer> {
-    return this.pdf.generateInvoice(payload, 'A4'); // 'A4' | 'TICKET_80MM' | 'STICKER_A6'
-  }
-}
-```
-
-Sin `pdf.licenseKey` configurada (o con una key inválida/expirada), los métodos de PDF lanzan un `PdfLicenseError`.
-
-### Personalizar diseño (logo y color de marca)
-
-El formato `A4` acepta branding opcional. Si no se especifica, usa un azul corporativo por defecto.
-
-```typescript
-return this.pdf.generateInvoice(payload, 'A4', {
-  licenseKey: 'OTRA_LICENSE_KEY', // opcional — tiene prioridad sobre la del módulo
-  branding: {
-    color: '#0f766e',                        // hex, opcional
-    logoBase64: 'data:image/png;base64,...',  // opcional
-  },
-});
-```
-
-### Nota de Crédito / Débito
+## Documentos soportados
 
-Mismo diseño y misma licencia que las facturas.
-
-```typescript
-await this.pdf.generateNote(notePayload, 'A4'); // 'A4' | 'TICKET_80MM' | 'STICKER_A6'
-```
-
-### Guía de Remisión (GRE)
-
-Solo formato `A4` — incluye destinatario, datos de traslado, punto de partida/llegada, transportista/vehículo/conductor.
-
-```typescript
-await this.pdf.generateDespatch(despatchPayload, {
-  branding: { color: '#0f766e' }, // opcional
-});
-```
-
-> Resumen Diario (RC) y Comunicación de Baja (RA) no tienen representación en PDF — son comunicaciones internas a SUNAT, no documentos que se entreguen a un cliente ni que viajen con la mercadería.
+| Tipo | Método | Descripción |
+|------|--------|-------------|
+| Factura (01) | `sendInvoice()` | Factura electrónica — SOAP síncrono |
+| Boleta (03) | `sendInvoice()` | Boleta de venta electrónica — SOAP síncrono |
+| Nota de Crédito (07) | `sendNote()` | NC electrónica — SOAP síncrono |
+| Nota de Débito (08) | `sendNote()` | ND electrónica — SOAP síncrono |
+| Guía de Remisión (09) | `sendDespatch()` | GRE 2022 — REST/OAuth asíncrono |
+| Resumen Diario (RC) | `sendSummary()` | Resumen de boletas — SOAP asíncrono |
+| Comunicación de Baja (RA) | `sendVoided()` | Baja de comprobantes — SOAP asíncrono |
+| Consulta de ticket | `getTicketStatus()` | Estado de procesos asíncronos |
 
 ## Testing / Modo simulado
 
@@ -383,6 +288,24 @@ const moduleRef = await Test.createTestingModule({
 
 No se realiza ninguna llamada HTTP — el XML se genera y firma normalmente, solo el envío a SUNAT es simulado.
 
+## Generación de PDF
+
+```typescript
+import { DocumentPdfService } from 'sunat-engine-nest';
+
+@Injectable()
+export class InvoicesService {
+  constructor(
+    private readonly engine: SunatEngineService,
+    private readonly pdf: DocumentPdfService,
+  ) {}
+
+  async getPdf(payload: InvoicePayload): Promise<Buffer> {
+    return this.pdf.generateInvoice(payload, 'A4'); // 'A4' | 'TICKET_80MM' | 'STICKER_A6'
+  }
+}
+```
+
 ## Respuesta del motor
 
 ```typescript
@@ -426,4 +349,4 @@ Cualquier aporte, por pequeño que sea, ayuda a mantener la librería actualizad
 
 ## Licencia
 
-MIT — excepto la generación de PDF (`DocumentPdfService`), que requiere una license key comercial. Ver [Generación de PDF](#generación-de-pdf-función-paga).
+MIT

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { SunatEngineModule, SUNAT_ENGINE_OPTIONS } from './sunat-engine.module';
-export type { SunatEngineOptions, SunatEngineAsyncOptions, SunatEngineGreOptions, SunatEngineCredentialsOptions, SunatEngineOseOptions, SunatEnginePdfOptions } from './sunat-engine.module';
+export type { SunatEngineOptions, SunatEngineAsyncOptions, SunatEngineGreOptions, SunatEngineCredentialsOptions, SunatEngineOseOptions } from './sunat-engine.module';
 export { SunatEngineService } from './sunat-engine.service';
 export { XmlSignerService } from './signer/xml-signer.service';
 export { SunatSoapClient } from './soap/sunat-soap.client';
@@ -10,9 +10,7 @@ export { OseClient } from './ose/ose.client';
 export type { OseClientOptions } from './ose/ose.client';
 export { CdrParserService } from './cdr/cdr-parser.service';
 export { DocumentPdfService } from './pdf/document-pdf.service';
-export type { PdfFormat, PdfBranding, PdfGenerationOptions } from './pdf/document-pdf.service';
-export { PdfLicenseError } from './licensing/pdf-license.service';
-export type { PdfLicensePayload } from './licensing/pdf-license.service';
+export type { PdfFormat } from './pdf/document-pdf.service';
 export { buildInvoiceXml } from './xml/invoice.builder';
 export { buildNoteXml } from './xml/note.builder';
 export { buildDespatchXml } from './xml/despatch.builder';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildVoidedXml = exports.buildSummaryXml = exports.buildDespatchXml = exports.buildNoteXml = exports.buildInvoiceXml = exports.PdfLicenseError = exports.DocumentPdfService = exports.CdrParserService = exports.OseClient = exports.SunatGreClient = exports.FakeSunatSoapClient = exports.SunatSoapClient = exports.XmlSignerService = exports.SunatEngineService = exports.SUNAT_ENGINE_OPTIONS = exports.SunatEngineModule = void 0;
+exports.buildVoidedXml = exports.buildSummaryXml = exports.buildDespatchXml = exports.buildNoteXml = exports.buildInvoiceXml = exports.DocumentPdfService = exports.CdrParserService = exports.OseClient = exports.SunatGreClient = exports.FakeSunatSoapClient = exports.SunatSoapClient = exports.XmlSignerService = exports.SunatEngineService = exports.SUNAT_ENGINE_OPTIONS = exports.SunatEngineModule = void 0;
 var sunat_engine_module_1 = require("./sunat-engine.module");
 Object.defineProperty(exports, "SunatEngineModule", { enumerable: true, get: function () { return sunat_engine_module_1.SunatEngineModule; } });
 Object.defineProperty(exports, "SUNAT_ENGINE_OPTIONS", { enumerable: true, get: function () { return sunat_engine_module_1.SUNAT_ENGINE_OPTIONS; } });
@@ -20,8 +20,6 @@ var cdr_parser_service_1 = require("./cdr/cdr-parser.service");
 Object.defineProperty(exports, "CdrParserService", { enumerable: true, get: function () { return cdr_parser_service_1.CdrParserService; } });
 var document_pdf_service_1 = require("./pdf/document-pdf.service");
 Object.defineProperty(exports, "DocumentPdfService", { enumerable: true, get: function () { return document_pdf_service_1.DocumentPdfService; } });
-var pdf_license_service_1 = require("./licensing/pdf-license.service");
-Object.defineProperty(exports, "PdfLicenseError", { enumerable: true, get: function () { return pdf_license_service_1.PdfLicenseError; } });
 var invoice_builder_1 = require("./xml/invoice.builder");
 Object.defineProperty(exports, "buildInvoiceXml", { enumerable: true, get: function () { return invoice_builder_1.buildInvoiceXml; } });
 var note_builder_1 = require("./xml/note.builder");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,6DAAgF;AAAvE,wHAAA,iBAAiB,OAAA;AAAE,2HAAA,oBAAoB,OAAA;AAIhD,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA;AAG3B,kEAA+D;AAAtD,sHAAA,gBAAgB,OAAA;AACzB,8DAA2D;AAAlD,oHAAA,eAAe,OAAA;AAExB,wEAAoE;AAA3D,6HAAA,mBAAmB,OAAA;AAC5B,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,+CAA6C;AAApC,uGAAA,SAAS,OAAA;AAElB,+DAA4D;AAAnD,sHAAA,gBAAgB,OAAA;AACzB,mEAAgE;AAAvD,0HAAA,kBAAkB,OAAA;AAE3B,uEAAkE;AAAzD,sHAAA,eAAe,OAAA;AAIxB,yDAAwD;AAA/C,kHAAA,eAAe,OAAA;AACxB,mDAAkD;AAAzC,4GAAA,YAAY,OAAA;AACrB,2DAA0D;AAAjD,oHAAA,gBAAgB,OAAA;AACzB,yDAAwD;AAA/C,kHAAA,eAAe,OAAA;AACxB,uDAAsD;AAA7C,gHAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,6DAAgF;AAAvE,wHAAA,iBAAiB,OAAA;AAAE,2HAAA,oBAAoB,OAAA;AAIhD,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA;AAG3B,kEAA+D;AAAtD,sHAAA,gBAAgB,OAAA;AACzB,8DAA2D;AAAlD,oHAAA,eAAe,OAAA;AAExB,wEAAoE;AAA3D,6HAAA,mBAAmB,OAAA;AAC5B,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,+CAA6C;AAApC,uGAAA,SAAS,OAAA;AAElB,+DAA4D;AAAnD,sHAAA,gBAAgB,OAAA;AACzB,mEAAgE;AAAvD,0HAAA,kBAAkB,OAAA;AAI3B,yDAAwD;AAA/C,kHAAA,eAAe,OAAA;AACxB,mDAAkD;AAAzC,4GAAA,YAAY,OAAA;AACrB,2DAA0D;AAAjD,oHAAA,gBAAgB,OAAA;AACzB,yDAAwD;AAA/C,kHAAA,eAAe,OAAA;AACxB,uDAAsD;AAA7C,gHAAA,cAAc,OAAA"}

package/dist/pdf/document-pdf.service.d.ts

@@ -1,40 +1,11 @@
-import { InvoicePayload, NotePayload, DespatchPayload } from '../types/sunat.types';
-import { SunatEngineOptions } from '../sunat-engine.module';
-import { PdfLicenseService } from '../licensing/pdf-license.service';
+import { InvoicePayload } from '../types/sunat.types';
 export type PdfFormat = 'A4' | 'TICKET_80MM' | 'STICKER_A6';
-export interface PdfBranding {
-    logoBase64?: string;
-    color?: string;
-}
-export interface PdfGenerationOptions {
-    licenseKey?: string;
-    branding?: PdfBranding;
-}
 export declare class DocumentPdfService {
-    private readonly options;
-    private readonly license;
-    constructor(options?: SunatEngineOptions, license?: PdfLicenseService);
-    generateInvoice(payload: InvoicePayload, format?: PdfFormat, opts?: PdfGenerationOptions): Promise<Buffer>;
-    private generateInvoiceA4;
-    private generateInvoiceTicket;
-    generateNote(payload: NotePayload, format?: PdfFormat, opts?: PdfGenerationOptions): Promise<Buffer>;
-    private generateNoteA4;
-    private generateNoteTicket;
-    generateDespatch(payload: DespatchPayload, opts?: PdfGenerationOptions): Promise<Buffer>;
-    private buildHeader;
-    private buildItemsTable;
-    private buildTotalsQrBlock;
-    private cardLayout;
-    private zebraTableLayout;
-    private baseStyles;
-    private resolveBranding;
-    private ticketHeader;
-    private ticketDivider;
-    private ticketDetailRow;
+    generateInvoice(payload: InvoicePayload, format?: PdfFormat): Promise<Buffer>;
+    private generateA4;
+    private generateTicket;
     private totRow;
     private buildQrContent;
-    private qr;
     private fmt;
-    private lighten;
     private renderPdf;
 }