Skip to content

Commit d9392a2

Browse files
MisaelMaMisaelMa
committed
feat: update readmes for all 15 packages with visual ecosystem
- add card images from MisaelMa/cards repo as hero for each package - add CFDI ecosystem table with all 15 cards across all READMEs - add npm, downloads, license, node, TypeScript badges - add documentation, ecosystem and author images - document dual XSLT engine support in @cfdi/xml (transform + saxon)
1 parent 4687230 commit d9392a2

15 files changed

Lines changed: 2016 additions & 889 deletions

File tree

‎packages/cfdi/catalogos/README.md‎

Lines changed: 145 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,160 @@
1-
# @cfdi/catalogos
1+
<p align="center">
2+
<a href="https://www.npmjs.com/package/@cfdi/catalogos">
3+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-catalogos.png" alt="@cfdi/catalogos" width="400" />
4+
</a>
5+
</p>
26

3-
Catalogos oficiales del SAT para CFDI 4.0. Contiene enums, tipos y listas de valores para formas de pago, metodos de pago, regimenes fiscales, tipos de comprobante, usos de CFDI, impuestos y exportacion.
7+
<h3 align="center">Catalogos oficiales del SAT para CFDI 4.0 como enums TypeScript</h3>
8+
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/@cfdi/catalogos">
11+
<img src="https://img.shields.io/npm/v/@cfdi/catalogos?style=flat-square&color=cb3837&label=npm" alt="npm version" />
12+
</a>
13+
<a href="https://www.npmjs.com/package/@cfdi/catalogos">
14+
<img src="https://img.shields.io/npm/dm/@cfdi/catalogos?style=flat-square&color=cb3837&label=downloads" alt="npm downloads" />
15+
</a>
16+
<a href="https://github.com/MisaelMa/node-cfdi/blob/main/LICENSE">
17+
<img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="license" />
18+
</a>
19+
<img src="https://img.shields.io/badge/node-%3E%3D22-brightgreen?style=flat-square&logo=node.js&logoColor=white" alt="node" />
20+
<img src="https://img.shields.io/badge/TypeScript-strict-3178c6?style=flat-square&logo=typescript&logoColor=white" alt="typescript" />
21+
</p>
22+
23+
<p align="center">
24+
<a href="https://cfdi.recreando.dev">
25+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/cfdi-documentacion.png" alt="Documentacion" width="300" />
26+
</a>
27+
</p>
28+
29+
---
30+
31+
## Ecosistema CFDI
32+
33+
<p align="center">
34+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/cfdi-ecosystem.png" alt="CFDI Ecosystem" width="600" />
35+
</p>
36+
37+
<table>
38+
<tr>
39+
<td align="center" width="33%">
40+
<a href="https://www.npmjs.com/package/@cfdi/xml">
41+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-xml.png" alt="@cfdi/xml" width="100%" />
42+
</a>
43+
</td>
44+
<td align="center" width="33%">
45+
<a href="https://www.npmjs.com/package/@cfdi/complementos">
46+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-complementos.png" alt="@cfdi/complementos" width="100%" />
47+
</a>
48+
</td>
49+
<td align="center" width="33%">
50+
<a href="https://www.npmjs.com/package/@cfdi/xsd">
51+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-xsd.png" alt="@cfdi/xsd" width="100%" />
52+
</a>
53+
</td>
54+
</tr>
55+
<tr>
56+
<td align="center" width="33%">
57+
<a href="https://www.npmjs.com/package/@cfdi/csd">
58+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-csd.png" alt="@cfdi/csd" width="100%" />
59+
</a>
60+
</td>
61+
<td align="center" width="33%">
62+
<a href="https://www.npmjs.com/package/@cfdi/csf">
63+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-csf.png" alt="@cfdi/csf" width="100%" />
64+
</a>
65+
</td>
66+
<td align="center" width="33%">
67+
<a href="https://www.npmjs.com/package/@cfdi/catalogos">
68+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-catalogos.png" alt="@cfdi/catalogos" width="100%" />
69+
</a>
70+
</td>
71+
</tr>
72+
<tr>
73+
<td align="center" width="33%">
74+
<a href="https://www.npmjs.com/package/@cfdi/transform">
75+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-transform.png" alt="@cfdi/transform" width="100%" />
76+
</a>
77+
</td>
78+
<td align="center" width="33%">
79+
<a href="https://www.npmjs.com/package/@cfdi/elements">
80+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-elements.png" alt="@cfdi/elements" width="100%" />
81+
</a>
82+
</td>
83+
<td align="center" width="33%">
84+
<a href="https://www.npmjs.com/package/@cfdi/types">
85+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-types.png" alt="@cfdi/types" width="100%" />
86+
</a>
87+
</td>
88+
</tr>
89+
<tr>
90+
<td align="center" width="33%">
91+
<a href="https://www.npmjs.com/package/@cfdi/expresiones">
92+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-expresiones.png" alt="@cfdi/expresiones" width="100%" />
93+
</a>
94+
</td>
95+
<td align="center" width="33%">
96+
<a href="https://www.npmjs.com/package/@cfdi/xml2json">
97+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-2json.png" alt="@cfdi/xml2json" width="100%" />
98+
</a>
99+
</td>
100+
<td align="center" width="33%">
101+
<a href="https://www.npmjs.com/package/@cfdi/rfc">
102+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-rfc.png" alt="@cfdi/rfc" width="100%" />
103+
</a>
104+
</td>
105+
</tr>
106+
<tr>
107+
<td align="center" width="33%">
108+
<a href="https://www.npmjs.com/package/@cfdi/utils">
109+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/cfdi-utils.png" alt="@cfdi/utils" width="100%" />
110+
</a>
111+
</td>
112+
<td align="center" width="33%">
113+
<a href="https://www.npmjs.com/package/@clir/openssl">
114+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/clir-openssl.png" alt="@clir/openssl" width="100%" />
115+
</a>
116+
</td>
117+
<td align="center" width="33%">
118+
<a href="https://www.npmjs.com/package/@saxon-he/cli">
119+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/packages/saxon-he-cli.png" alt="@saxon-he/cli" width="100%" />
120+
</a>
121+
</td>
122+
</tr>
123+
</table>
124+
125+
---
4126

5127
## Instalacion
6128

7129
```bash
8130
npm install @cfdi/catalogos
9131
```
10132

11-
## Uso
12-
13-
```typescript
14-
import {
15-
FormaPago,
16-
MetodoPago,
17-
RegimenFiscal,
18-
TipoComprobante,
19-
UsoCFDI,
20-
Impuesto,
21-
ExportacionEnum,
22-
FormaPagoList,
23-
} from '@cfdi/catalogos';
24-
25-
// Usar enums directamente
26-
const pago = FormaPago.TRANSFERENCIA_ELECTRONICA; // '03'
27-
const metodo = MetodoPago.PUE; // Pago en Una sola Exhibicion
28-
const regimen = RegimenFiscal.GENERAL_DE_LEY; // Regimen general
29-
const tipo = TipoComprobante.INGRESO;
30-
const uso = UsoCFDI.GASTOS_EN_GENERAL;
31-
const impuesto = Impuesto.IVA;
32-
const exportacion = ExportacionEnum.NoAplica; // '01'
33-
34-
// Listas para selects/dropdowns
35-
console.log(FormaPagoList);
36-
// [{ label: 'Efectivo', value: '01' }, { label: 'Cheque nominativo', value: '02' }, ...]
37-
```
133+
---
134+
135+
## Soporte
136+
137+
<p>
138+
<a href="https://github.com/MisaelMa/node-cfdi/issues">
139+
<img src="https://img.shields.io/badge/GitHub-Issues-181717?style=for-the-badge&logo=github" alt="issues" />
140+
</a>
141+
<a href="https://github.com/MisaelMa/node-cfdi/discussions">
142+
<img src="https://img.shields.io/badge/GitHub-Discussions-181717?style=for-the-badge&logo=github" alt="discussions" />
143+
</a>
144+
<a href="https://www.npmjs.com/package/@cfdi/catalogos">
145+
<img src="https://img.shields.io/badge/npm-@cfdi/catalogos-cb3837?style=for-the-badge&logo=npm" alt="npm" />
146+
</a>
147+
</p>
38148

39-
## API
40-
41-
| Export | Tipo | Descripcion |
42-
|--------|------|-------------|
43-
| `FormaPago` | enum | Claves de forma de pago (01-99) |
44-
| `FormaPagoList` | array | Lista con label/value para UI |
45-
| `FormaPagoType` | type | Tipo union de claves validas |
46-
| `MetodoPago` | enum | PUE, PPD |
47-
| `RegimenFiscal` | enum | Regimenes fiscales del SAT |
48-
| `TipoComprobante` | enum | Ingreso, Egreso, Traslado, Nomina, Pago |
49-
| `UsoCFDI` | enum | Usos del CFDI |
50-
| `Impuesto` | enum | IVA, ISR, IEPS |
51-
| `ExportacionEnum` | enum | NoAplica, Definitiva, Temporal |
52-
| `ExportacionType` | type | Tipo union de claves de exportacion |
149+
---
53150

54151
## Autor
55152

56-
**Amir Misael Marin Coh** — [@MisaelMa](https://github.com/MisaelMa)
153+
<p align="center">
154+
<a href="https://github.com/MisaelMa">
155+
<img src="https://raw.githubusercontent.com/MisaelMa/cards/main/author.png" alt="Amir Misael Marin Coh" width="450" />
156+
</a>
157+
</p>
57158

58159
## Licencia
59160

0 commit comments

Comments
 (0)