@nodecfdi/cfdiutils-common
Sub-library of
@nodecfdi/cfdiutils-common
for common structs and helpers
:us: The documentation of this project is in spanish as this is the natural language for intended audience.
:mexico: La documentación del proyecto está en español porque ese es el lenguaje principal de los usuarios.
@nodecfdi/cfdiutils-common
Librería para contener las estructuras de datos comunes, y utilerías o funciones de ayuda común. Inspirada por la versión de php https://github.com/eclipxe13/CfdiUtils
npm i @nodecfdi/cfdiutils-common --save
yarn add @nodecfdi/cfdiutils-common --save
pnpm add @nodecfdi/cfdiutils-common --save
Usa la versión mas reciente publicada cambiando <latest-version>
por la última versión. Por ejemplo ...cfdiutils-common@2.0.1/dist...
<script src="https://unpkg.com/@nodecfdi/cfdiutils-common@<latest-version>/dist/cfdiutils-common.global.js"></script>
Estructura de datos Node
import { Node } from '@nodecfdi/cfdiutils-common';
// Creación de un nodo con atributos
const node = new Node('root', {
id: '1',
});
console.log(node.attributes().get('id')); // '1'
console.log(node.attributes().get('no-existe')); // cadena de caracteres vacia ''
console.log(node.attributes().get('no-existe') ? 'si' : 'no'); // 'no'
node.attributes().set('atributo', 'valor'); // establece el valor
node.attributes().delete('id'); // elimina el atributo 'id'
// recorrer la colección de atributos
node.attributes().forEach((attributeValue, attributeName) => {
console.log(`${attributeName}: ${attributeValue}`);
});
Utileria XmlNodeUtils y XML
import { Node, install, Xml, XmlNodeUtils } from '@nodecfdi/cfdiutils-common';
// DomParser, XMLSerializer, DOMImplementation agnostic can use xmldom, jsdom, etc.
// Is necesary install for XML helper and XmlNodeUtils
install(new DOMParser(), new XMLSerializer(), new DOMImplementation());
const node = new Node('book', {}, [new Node('chapter', { toc: '1' }), new Node('chapter', { toc: '2' })]);
const xmlString = XmlNodeUtils.nodeToXmlString(node, true);
console.log(xmlString); // xml valido en formato string
// Create xml document from xml string
const document = Xml.newDocumentContent('my xml string');
// create node from element
const node = XmlNodeUtils.nodeFromXmlElement(Xml.documentElement(document));
Esta es la estructura básica. Un nodo debe tener un nombre y esta propiedad no se puede cambiar. Su constructor admite tres parámetros:
name: string
: Nombre del nodo, se eliminan espacios en blanco al inicio y al final, no permite vacíos.attributes: Record<string, unknown>
: Objeto de elementos clave/valor que serán importados como atributos.nodes: Node[]
: Arreglo de elementos Node
que serán importados como nodos hijo.Se accede a sus atributos utilizando la forma de Map de javascript siguiendo estas reglas básicas:
toString
Los atributos se manejan con una colección de tipo Attributes
y se pueden obtener usando el método attributes()
en
el objeto Node
.
Los nodos hijos se manejan a través de una colección de nodos Nodes
. Se puede acceder al objeto Nodes
usando el
método children()
en el objeto Node
.
Cuando se itera el objeto en realidad se está iterando sobre la colección de nodos.
La clase Node
tiene estos métodos de ayuda que sirven para trabajar directamente sobre la colección Nodes:
foreach
se realiza sobre la colección de nodos.addChild(node: Node)
: Agrega un nodo en la colección de nodos.Esta es una clase de utilerías que contiene métodos estáticos que permiten crear estructuras de nodos desde XML y generar XML a partir de los nodos. Recuerde que los nodos solo pueden almacenar atributos y nodos hijos.
Actualmente, permite exportar e importar a/desde: Document
, Element
y string
(con contenido válido).
Advertencias:
Tradicionalmente, los CFDI Regulares, CFDI de Retenciones e Información de Pagos, así como sus complementos, siguen la estructura de elementos con valores en los atributos y sin texto.
Sin embargo, el SAT —en su infinita consistencia— tiene el Complemento de facturas del sector de ventas al detalle disponible en https://www.sat.gob.mx/consulta/76197/complemento-para-factura-electronica donde, en lugar de poner los valores en atributos, pone los valores en el contenido textual del elemento, además de otros cambios como usar nombres de nodos en inglés.
Por lo anterior, se introdujo la interfaz NodeHasValueInterface
que contiene los métodos value(): string
y
setValue(valueString: string): void
con lo que se puede escribir y leer este contenido simple.
Puedes obtener soporte abriendo un ticket en Github.
Adicionalmente, esta librería pertenece a la comunidad OcelotlStudio, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.
Esta librería se mantendrá compatible con al menos la versión con soporte activo de Node más reciente.
También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.
Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para más detalles y recuerda revisar el archivo CHANGELOG.
The @nodecfdi/cfdiutils-common
library is copyright © NodeCfdi - OcelotlStudio and licensed for use under the MIT License (MIT). Please see LICENSE for more information.
Generated using TypeDoc