@empleado-juan/commons 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,169 @@
+# @empleado-juan/commons
+
+[![npm version](https://badge.fury.io/js/%40empleado-juan%2Fcommons.svg)](https://www.npmjs.com/package/@empleado-juan/commons)
+
+Paquete de código compartido entre frontend y backend para el sistema Empleado Juan Control.
+
+## Instalación
+
+```bash
+npm install @empleado-juan/commons
+```
+
+## Características
+
+- ✅ **TypeScript**: Tipos completamente tipados
+- ✅ **Tree-shakeable**: Solo importa lo que necesitas
+- ✅ **Zero dependencies**: No trae dependencias extra
+- ✅ **ESM + CommonJS**: Compatible con ambos formatos
+
+## Contenido
+
+### 📦 Types
+
+Interfaces TypeScript compartidas:
+
+```typescript
+import type {
+  AttendanceRecord,
+  EmployeeData,
+  LicenseStatus,
+  EventMessage,
+  HeartbeatMetrics
+} from '@empleado-juan/commons';
+
+// Ejemplo de uso
+const attendance: AttendanceRecord = {
+  id: '123',
+  employeeId: 'emp-456',
+  timestamp: new Date(),
+  eventType: 'CHECK_IN',
+  branchId: 'branch-1'
+};
+```
+
+### 🏷️ Enums
+
+Enumeraciones del dominio:
+
+```typescript
+import {
+  AttendanceEventType,
+  PaymentType,
+  LicenseValidationReason,
+  MessageBrokerType
+} from '@empleado-juan/commons';
+
+// Ejemplo de uso
+if (record.eventType === AttendanceEventType.CHECK_IN) {
+  console.log('Empleado ingresó');
+}
+
+const paymentType = PaymentType.BIWEEKLY;
+```
+
+**Enums disponibles**:
+- `AttendanceEventType`: CHECK_IN, CHECK_OUT, BREAK_START, BREAK_END, etc.
+- `PaymentType`: MONTHLY, BIWEEKLY, WEEKLY
+- `ContractType`: FULL_TIME, PART_TIME, CONTRACTOR, TEMPORARY
+- `LicenseValidationReason`: VALID, EXPIRED, INVALID, etc.
+- `MessageBrokerType`: RABBITMQ, KAFKA, SQS
+
+### 🔧 Constants
+
+Constantes del sistema:
+
+```typescript
+import { LICENSE_CONSTANTS } from '@empleado-juan/commons';
+
+// Ejemplo de uso
+const cacheTTL = LICENSE_CONSTANTS.CACHE_TTL; // 5 minutos
+const gracePeriod = LICENSE_CONSTANTS.GRACE_PERIOD; // 24 horas
+```
+
+### 📡 Event Topics
+
+Definición de eventos del sistema:
+
+```typescript
+import { EVENT_TOPICS } from '@empleado-juan/commons';
+
+// Ejemplo de uso
+const topic = EVENT_TOPICS.ATTENDANCE_CREATED; // 'attendance-created'
+const empTopic = EVENT_TOPICS.EMPLOYEE_UPDATED; // 'employee-updated'
+```
+
+**Topics disponibles**:
+- `ATTENDANCE_CREATED`, `ATTENDANCE_UPDATED`
+- `EMPLOYEE_CREATED`, `EMPLOYEE_UPDATED`, `EMPLOYEE_DELETED`
+- `COMPENSATION_CREATED`, `COMPENSATION_UPDATED`
+- `SCHEDULE_CREATED`, `SCHEDULE_UPDATED`
+
+## Ejemplos de Uso
+
+### Frontend (React/Next.js)
+
+```typescript
+import { AttendanceEventType, type EmployeeData } from '@empleado-juan/commons';
+
+function EmployeeCard({ employee }: { employee: EmployeeData }) {
+  return (
+    <div>
+      <h3>{employee.firstName} {employee.lastName}</h3>
+      <p>Status: {employee.isActive ? 'Activo' : 'Inactivo'}</p>
+    </div>
+  );
+}
+```
+
+### Backend (Node.js)
+
+```typescript
+import { EVENT_TOPICS, type EventMessage } from '@empleado-juan/commons';
+
+async function publishEvent(topic: string, data: any) {
+  const message: EventMessage = {
+    key: data.id,
+    value: data,
+    headers: {
+      'event-type': topic,
+      'timestamp': new Date().toISOString()
+    }
+  };
+
+  await messageQueue.send(EVENT_TOPICS.EMPLOYEE_CREATED, message);
+}
+```
+
+## Desarrollo
+
+### Setup
+
+```bash
+git clone <repo>
+cd commons
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Publish
+
+```bash
+# Incrementar versión
+npm version patch|minor|major
+
+# Compilar
+npm run build
+
+# Publicar
+npm publish --access public
+```
+
+## License
+
+MIT © Empleado Juan Team

package/dist/enums/index.d.ts

@@ -34,6 +34,7 @@ export declare enum ContractType {
 export declare enum PayrollFrequency {
     WEEKLY = "WEEKLY",
     BIWEEKLY = "BIWEEKLY",
+    QUINCENAL = "QUINCENAL",
     MONTHLY = "MONTHLY"
 }
 export declare enum UserRole {

package/dist/enums/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAGD,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAGD,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAGD,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAGD,oBAAY,YAAY;IACtB,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAGD,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAGD,oBAAY,QAAQ;IAClB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAGD,oBAAY,kBAAkB;IAC5B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAGD,oBAAY,uBAAuB;IACjC,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,sBAAsB,2BAA2B;IACjD,sBAAsB,2BAA2B;IACjD,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;CAC9C;AAGD,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAGD,oBAAY,OAAO;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAGD,oBAAY,iBAAiB;IAC3B,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;CACxB;AAGD,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAGD,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAGD,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAGD,oBAAY,YAAY;IACtB,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAGD,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAGD,oBAAY,QAAQ;IAClB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAGD,oBAAY,kBAAkB;IAC5B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAGD,oBAAY,uBAAuB;IACjC,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,sBAAsB,2BAA2B;IACjD,sBAAsB,2BAA2B;IACjD,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;CAC9C;AAGD,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAGD,oBAAY,OAAO;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAGD,oBAAY,iBAAiB;IAC3B,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ"}

package/dist/enums/index.js

@@ -46,6 +46,7 @@ export var PayrollFrequency;
 (function (PayrollFrequency) {
     PayrollFrequency["WEEKLY"] = "WEEKLY";
     PayrollFrequency["BIWEEKLY"] = "BIWEEKLY";
+    PayrollFrequency["QUINCENAL"] = "QUINCENAL";
     PayrollFrequency["MONTHLY"] = "MONTHLY";
 })(PayrollFrequency || (PayrollFrequency = {}));
 // User Roles

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empleado-juan/commons",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Shared code between frontend and backend services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/enums/index.ts

@@ -46,6 +46,7 @@ export enum ContractType {
 export enum PayrollFrequency {
   WEEKLY = 'WEEKLY',
   BIWEEKLY = 'BIWEEKLY',
+  QUINCENAL = 'QUINCENAL',
   MONTHLY = 'MONTHLY',
 }