Merge pull request #1 from redocmx/feat/addenda

feat: add addenda support

Author: danioso

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redocmx",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Conversión CFDI a PDF",
   "main": "src/index.js",
   "types": "src/types.d.ts",

src/addenda.js

@@ -0,0 +1,26 @@
+import File from './file.js';
+
+export default class Addenda extends File {
+    constructor() {
+        super()
+    }
+
+    replaceValues(content, options = null) {
+        if(!options) return content
+
+        for(const option of Object.entries(options)) {
+            const [key, value] = option
+            content = content.split(key).join(value)
+        }
+
+        return content
+    }
+
+    async getFileContent(replaceValues) {
+        const file = await this.getFile()
+        const fileContent = file.content.toString()
+        
+        return this.replaceValues(fileContent, replaceValues)
+    }
+
+}

src/cfdi.js

@@ -1,90 +1,53 @@
-import fs from 'fs/promises';
 import Service from './service.js';
 import Pdf from './pdf.js';
+import Addenda from './addenda.js';
+import File from './file.js';
 
-const { F_OK, R_OK } = fs.constants;
-
-export default class Cfdi {
+export default class Cfdi extends File {
     constructor() {
+        super();
         this.pdf = null;
-        this.addenda = null;
-        this.filePath = null;
-        this.fileBuffer = null;
-        this.fileContent = null;
-        this.service = Service.getInstance();
-    }
 
-    fromFile(filePath) {
-        this.filePath = filePath;
-        return this;
-    }
+        this.addenda = null
+        this.addendaReplaceValues = null
 
-    fromString(fileContent) {
-        this.fileContent = fileContent;
-        return this;
+        this.service = Service.getInstance();
     }
 
-    async getXmlContent() {
-        if(this.fileContent){
-            return { content: this.fileContent, type: 'string' }
+    setAddenda(addenda, replaceValues = null) {
+        if (addenda && !(addenda instanceof Addenda)) {
+            throw new TypeError('Addenda must be Addenda instance.');
         }
 
-        if(this.fileBuffer){
-            return { content: this.fileBuffer, type: 'buffer' }
-        }
-
-        if(this.filePath){
-            try {
-                await fs.access(this.filePath, F_OK | R_OK);
-            } catch (err) {
-                if (err.code === 'ENOENT') {
-                    throw new Error(`Failed to read XML content from file: ${this.filePath}. The file does not exist.`);
-                } else if (err.code === 'EACCES') {
-                    throw new Error(`Permission denied: ${this.filePath}. The file exists but cannot be read.`);
-                } else {
-                    throw err;
-                }
-            }
-
-            this.fileBuffer = await fs.readFile(this.filePath)
-            return { content: this.fileBuffer, type: 'buffer' }
-        }
-
-        throw new Error('XML content for the CFDI must be provided.');
-    }
-
-    setAddenda ( addenda ) {
-        if (typeof addenda !== 'string') {
-            throw new TypeError('setAddenda function only accepts a string parameter.');
+        if (replaceValues && Object.prototype.toString.call(replaceValues) !== '[object Object]') {
+            throw new TypeError('Addenda replace values must be a valid key - value object.');
         }
 
         this.addenda = addenda
+        this.addendaReplaceValues = replaceValues
     }
 
-    getAddenda () {
-        return this.addenda
-    }
-
-    async toPdf( payload = {} ) {
-
-        if(this.pdf){
+    async toPdf(payload = {}) {
+        if (this.pdf) {
             return this.pdf;
         }
 
         if (Object.prototype.toString.call(payload) !== '[object Object]') {
             throw new TypeError('toPdf function only accepts an object as a parameter.');
         }
 
-        const file = await this.getXmlContent();
-        payload.format = 'pdf';
-        
-        if (this.getAddenda()) {
-            payload.addenda = this.getAddenda();
+        const file = await this.getFile();
+
+        if (this.addenda) {
+            const addendaContent = await this.addenda.getFileContent(this.addendaReplaceValues);
+            payload.addenda = addendaContent;
         }
-        
-        const result = await this.service.cfdisConvert({file, payload});
+
+        payload.format = 'pdf';
+
+        const result = await this.service.cfdisConvert({ file, payload });
         this.pdf = new Pdf(result);
-        
+
         return this.pdf;
     }
 }

src/file.js

@@ -0,0 +1,50 @@
+import fs from 'fs/promises';
+
+const { F_OK, R_OK } = fs.constants;
+
+export default class File {
+  constructor() {
+    this.filePath = null;
+    this.fileBuffer = null;
+    this.fileContent = null;
+  }
+
+  fromFile(filePath) {
+    this.filePath = filePath;
+    return this
+  }
+
+  fromString(fileContent) {
+    this.fileContent = fileContent;
+    return this
+  }
+
+  async getFile() {
+    if (this.fileContent) {
+      return { content: this.fileContent, type: 'string' }
+    }
+
+    if (this.fileBuffer) {
+      return { content: this.fileBuffer, type: 'buffer' }
+    }
+
+    if (this.filePath) {
+      try {
+        await fs.access(this.filePath, F_OK | R_OK);
+      } catch (err) {
+        if (err.code === 'ENOENT') {
+          throw new Error(`Failed to read content from file: ${this.filePath}. The file does not exist.`);
+        } else if (err.code === 'EACCES') {
+          throw new Error(`Permission denied: ${this.filePath}. The file exists but cannot be read.`);
+        } else {
+          throw err;
+        }
+      }
+
+      this.fileBuffer = await fs.readFile(this.filePath)
+      return { content: this.fileBuffer, type: 'buffer' }
+    }
+
+    throw new Error(`Failed to load file ${this.constructor.name}, you must use fromFile or fromString.`);
+  }
+}

src/index.js

@@ -1,4 +1,5 @@
 import Cfdi from './cfdi.js';
+import Addenda from './addenda.js';
 import Service from './service.js';
 
 export default class Redoc {
@@ -8,7 +9,10 @@ export default class Redoc {
     }
 
     get cfdi() {
-        const cfdi = new Cfdi()
-        return cfdi;
+        return new Cfdi();
+    }
+
+    get addenda() {
+        return new Addenda()
     }
 }

src/service.js

@@ -21,7 +21,7 @@ export default class Service {
     async cfdisConvert({file, payload}) {
 
         const formData = new FormData();
-        
+
         if(payload?.style_pdf){
             formData.append('style_pdf', payload.style_pdf);
         }

src/types.d.ts

@@ -1,27 +1,36 @@
 import Cfdi from './cfdi';
 import Service from './service';
 import Pdf from './pdf';
+import Addenda from './addenda';
 
 export default class Redoc {
     apiKey: string;
     service: Service;
     constructor(apiKey?: string);
     get cfdi(): Cfdi;
+    get addenda(): Addenda;
 }
 
-export default class Cfdi {
+export default class Cfdi extends File {
     pdf: Pdf | null;
-    addenda: string | null;
+    addenda: Addenda | null;
+    constructor();
+    setAddenda(addenda: Addenda, replaceValues?: object): void;
+    toPdf(payload?: CfdisConvertPayload): Promise<Pdf>;
+}
+export default class Addenda extends File {
+    constructor();
+    getFileContent(replaceValues?: object): Promise<string>;
+}
+
+export default class File {
     filePath: string | null;
     fileBuffer: Buffer | null;
     fileContent: string | null;
     constructor();
     fromFile(filePath: string): this;
     fromString(fileContent: string): this;
-    getXmlContent(): Promise<{ content: string | Buffer; type: 'string' | 'buffer' }>;
-    setAddenda(addenda: string): void;
-    getAddenda(): string | null;
-    toPdf(payload?: CfdisConvertPayload): Promise<Pdf>;
+    getFile(): Promise<{ content: string | Buffer; type: 'string' | 'buffer' }>;
 }
 
 export interface CfdisMetadata {