@endesyc/format 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,429 @@
+# ENDESYC Format Library
+
+Librería Angular compartida para fechas y montos.
+
+## Instalar
+```bash
+npm install
+npm test
+npm run build
+npm run pack
+```
+
+## Paquete
+```bash
+npm install @endesyc/format@1.0.2
+```
+
+# ENDESYC Format
+
+Angular library for formatting dates, times and Bolivian currency.
+
+---
+
+## Características
+
+✔ Formateo de fechas
+
+✔ Formateo de horas
+
+✔ Formateo de fechas y horas
+
+✔ Formateo de moneda boliviana (BOB)
+
+✔ Pipes para Angular
+
+✔ Utilidades reutilizables
+
+✔ Soporte para valores nulos
+
+✔ Formatos centralizados mediante DateFormats
+
+---
+
+# Instalación
+
+```bash
+npm install @endesyc/format
+```
+
+---
+
+# Requisitos
+
+Angular 18+
+
+Node.js 20+
+
+---
+
+# Importación
+
+## Utilidades
+
+```ts
+import {
+    DateUtil,
+    MoneyUtil,
+    DateFormats
+} from '@endesyc/format';
+```
+
+---
+
+## Pipes
+
+```ts
+import {
+    CompanyDatePipe,
+    CompanyMoneyPipe
+} from '@endesyc/format';
+```
+
+---
+
+# Fechas
+
+## Fecha de ejemplo
+
+```ts
+const createdAt = '2025-09-02 15:55:39.073';
+```
+
+---
+
+## Solo fecha
+
+```ts
+DateUtil.format(createdAt, DateFormats.DATE);
+```
+
+Resultado
+
+```
+02/09/2025
+```
+
+---
+
+## Solo hora
+
+```ts
+DateUtil.format(createdAt, DateFormats.TIME);
+```
+
+Resultado
+
+```
+15:55
+```
+
+---
+
+## Fecha y hora
+
+```ts
+DateUtil.format(createdAt, DateFormats.DATE_TIME);
+```
+
+Resultado
+
+```
+02/09/2025 15:55
+```
+
+---
+
+## Fecha y hora con segundos
+
+```ts
+DateUtil.format(createdAt, DateFormats.DATE_TIME_SECONDS);
+```
+
+Resultado
+
+```
+02/09/2025 15:55:39
+```
+
+---
+
+## Mes y año
+
+```ts
+DateUtil.format(createdAt, DateFormats.MONTH_YEAR);
+```
+
+Resultado
+
+```
+09/2025
+```
+
+---
+
+## Año
+
+```ts
+DateUtil.format(createdAt, DateFormats.YEAR);
+```
+
+Resultado
+
+```
+2025
+```
+
+---
+
+# HTML
+
+## Fecha
+
+```html
+{{ createdAt | companyDate:'date' }}
+```
+
+Resultado
+
+```
+02/09/2025
+```
+
+---
+
+## Hora
+
+```html
+{{ createdAt | companyDate:'time' }}
+```
+
+Resultado
+
+```
+15:55
+```
+
+---
+
+## Fecha y Hora
+
+```html
+{{ createdAt | companyDate:'dateTime' }}
+```
+
+Resultado
+
+```
+02/09/2025 15:55
+```
+
+---
+
+## Año
+
+```html
+{{ createdAt | companyDate:'year' }}
+```
+
+Resultado
+
+```
+2025
+```
+
+---
+
+# Dinero
+
+Monto de ejemplo
+
+```ts
+const amount = 1234.56;
+```
+
+---
+
+## Formato por defecto
+
+```ts
+MoneyUtil.formatBolivianos(amount);
+```
+
+Resultado
+
+```
+Bs 1.234,56
+```
+
+---
+
+## Sin símbolo
+
+```ts
+MoneyUtil.formatBolivianos(amount,{
+    showSymbol:false
+});
+```
+
+Resultado
+
+```
+1.234,56
+```
+
+---
+
+## Símbolo al final
+
+```ts
+MoneyUtil.formatBolivianos(amount,{
+    symbolPosition:'suffix'
+});
+```
+
+Resultado
+
+```
+1.234,56 Bs
+```
+
+---
+
+## Cuatro decimales
+
+```ts
+MoneyUtil.formatBolivianos(amount,{
+    maximumFractionDigits:4
+});
+```
+
+Resultado
+
+```
+Bs 1.234,5600
+```
+
+---
+
+# HTML
+
+```html
+{{ amount | companyMoney }}
+```
+
+Resultado
+
+```
+Bs 1.234,56
+```
+
+---
+
+## Sin símbolo
+
+```html
+{{ amount | companyMoney:{showSymbol:false} }}
+```
+
+---
+
+## Símbolo al final
+
+```html
+{{ amount | companyMoney:{symbolPosition:'suffix'} }}
+```
+
+---
+
+# DateFormats
+
+La librería centraliza los formatos disponibles mediante la clase DateFormats.
+
+```ts
+DateFormats.DATE
+
+DateFormats.TIME
+
+DateFormats.DATE_TIME
+
+DateFormats.DATE_TIME_SECONDS
+
+DateFormats.MONTH_YEAR
+
+DateFormats.YEAR
+```
+
+---
+
+# Validaciones
+
+```ts
+DateUtil.isValid(value)
+
+MoneyUtil.isValid(value)
+```
+
+---
+
+# Conversión
+
+```ts
+MoneyUtil.toNumber('1.234,56')
+```
+
+---
+
+# Estructura recomendada
+
+```
+shared
+
+    formatting.service.ts
+
+    formatting.pipe.ts
+
+    formatting.component.ts
+```
+
+---
+
+# Buenas prácticas
+
+✔ Utilice DateFormats en lugar de escribir formatos manualmente.
+
+✔ Reutilice los Pipes cuando sea posible.
+
+✔ Evite hardcodear patrones de fechas.
+
+✔ Mantenga todos los formatos corporativos centralizados.
+
+---
+
+# Versionado
+
+Esta librería utiliza Semantic Versioning.
+
+```
+MAJOR.MINOR.PATCH
+```
+
+Ejemplos
+
+```
+1.0.0
+
+1.0.1
+
+1.1.0
+
+2.0.0
+```
+
+---
+
+# Licencia
+
+Copyright © ENDESYC
+
+Todos los derechos reservados.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@endesyc/format",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Librería Angular compartida para formateo de fechas y montos monetarios.",
   "license": "UNLICENSED",
   "author": "ENDESYC",
   "sideEffects": false,
   "peerDependencies": {
-    "@angular/common": ">=18 <21",
-    "@angular/core": ">=18 <21",
+    "@angular/common": "^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0",
+    "@angular/core": "^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0",
     "dayjs": "^1.11.13"
   },
   "dependencies": {