regions-config 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# regions-config
|
|
2
2
|
|
|
3
3
|
Paquete de configuración de regiones para las aplicaciones de IATI. Proporciona la configuración completa de cada región (zona horaria, tipos de documento, métodos de pago, links de footer, países a redirigir, etc.) junto con utilidades tipadas para acceder a ella.
|
|
4
4
|
|
|
@@ -20,9 +20,9 @@ Paquete de configuración de regiones para las aplicaciones de IATI. Proporciona
|
|
|
20
20
|
## Instalación
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
npm install
|
|
23
|
+
npm install regions-config
|
|
24
24
|
# o
|
|
25
|
-
pnpm add
|
|
25
|
+
pnpm add regions-config
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
El paquete tiene acceso restringido (`publishConfig.access: "restricted"`). Asegúrate de estar autenticado en npm con una cuenta con permisos sobre el scope `@iati`:
|
|
@@ -38,7 +38,7 @@ Si lo consumes desde otra app o paquete del mismo workspace, puedes apuntar dire
|
|
|
38
38
|
```json
|
|
39
39
|
{
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"
|
|
41
|
+
"regions-config": "workspace:*"
|
|
42
42
|
}
|
|
43
43
|
}
|
|
44
44
|
```
|
|
@@ -50,7 +50,7 @@ Si lo consumes desde otra app o paquete del mismo workspace, puedes apuntar dire
|
|
|
50
50
|
Objeto con la configuración completa de todas las regiones, ya validada con Zod.
|
|
51
51
|
|
|
52
52
|
```ts
|
|
53
|
-
import { regionsConfig } from '
|
|
53
|
+
import { regionsConfig } from 'regions-config';
|
|
54
54
|
|
|
55
55
|
const spain = regionsConfig['es'];
|
|
56
56
|
console.log(spain.regionCode); // 'es-ES'
|
|
@@ -63,7 +63,7 @@ console.log(spain.regionCode); // 'es-ES'
|
|
|
63
63
|
Obtiene la configuración de una región a partir de su clave (elimina guiones y barras del nombre). Esto se usa generalmente para recuperar la config con la property **short_name** que viene del backend en el endpoint de **commons (commons.site.short_name)**
|
|
64
64
|
|
|
65
65
|
```ts
|
|
66
|
-
import { getRegionConfig } from '
|
|
66
|
+
import { getRegionConfig } from 'regions-config';
|
|
67
67
|
|
|
68
68
|
const config = getRegionConfig('com/co'); // equivalente a regionsConfig['comco']
|
|
69
69
|
```
|
|
@@ -75,7 +75,7 @@ const config = getRegionConfig('com/co'); // equivalente a regionsConfig['comco'
|
|
|
75
75
|
Obtiene la configuración de una región por su `id` numérico. Lanza un error si no se encuentra.
|
|
76
76
|
|
|
77
77
|
```ts
|
|
78
|
-
import { getRegionConfigById } from '
|
|
78
|
+
import { getRegionConfigById } from 'regions-config';
|
|
79
79
|
|
|
80
80
|
const config = getRegionConfigById(1); // región España
|
|
81
81
|
```
|
|
@@ -87,7 +87,7 @@ const config = getRegionConfigById(1); // región España
|
|
|
87
87
|
Obtiene la configuración de una región por su `regionCode`. Lanza un error si el código no existe.
|
|
88
88
|
|
|
89
89
|
```ts
|
|
90
|
-
import { getRegionConfigByRegionCode } from '
|
|
90
|
+
import { getRegionConfigByRegionCode } from 'regions-config';
|
|
91
91
|
|
|
92
92
|
const config = getRegionConfigByRegionCode('es-ES');
|
|
93
93
|
```
|
|
@@ -99,7 +99,7 @@ const config = getRegionConfigByRegionCode('es-ES');
|
|
|
99
99
|
Valida que un `regionCode` sea válido. Lanza un error si no corresponde a ninguna región configurada.
|
|
100
100
|
|
|
101
101
|
```ts
|
|
102
|
-
import { validateRegion } from '
|
|
102
|
+
import { validateRegion } from 'regions-config';
|
|
103
103
|
|
|
104
104
|
validateRegion('es-ES'); // OK
|
|
105
105
|
validateRegion('xx-XX'); // Error: Invalid region: xx-XX
|
|
@@ -112,7 +112,7 @@ validateRegion('xx-XX'); // Error: Invalid region: xx-XX
|
|
|
112
112
|
Resuelve las opciones de tipo de documento en función del país de origen del usuario (local o extranjero).
|
|
113
113
|
|
|
114
114
|
```ts
|
|
115
|
-
import { resolveDocumentTypeOptions } from '
|
|
115
|
+
import { resolveDocumentTypeOptions } from 'regions-config';
|
|
116
116
|
|
|
117
117
|
const options = resolveDocumentTypeOptions(
|
|
118
118
|
config.documentTypeOptions,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "regions-config",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"tsup": "8.4.0",
|
|
29
29
|
"typescript": "5.7.3",
|
|
30
|
-
"config-tsconfig": "workspace:*"
|
|
30
|
+
"config-tsconfig": "workspace:*",
|
|
31
|
+
"tsx": "4.19.3"
|
|
31
32
|
}
|
|
32
33
|
}
|