hvp-shared 3.1.0 → 3.2.1

package/dist/constants/collaborator.constants.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Collaborator Constants and Enums
+ *
+ * Shared enums used by both backend and frontend for collaborator management.
+ */
+/**
+ * Web Application Roles
+ *
+ * Defines user roles for authorization and access control.
+ * Used in JWT tokens, middleware, and UI role-based rendering.
+ */
+export declare enum WebAppRole {
+    admin = "Administrador",
+    manager = "Gerente",
+    collaborator = "Colaborador",
+    user = "User",
+    guest = "Invitado"
+}
+/**
+ * Educational Degree
+ *
+ * Academic level of collaborators for HR records.
+ */
+export declare enum Degree {
+    HighSchool = "Bachillerato",
+    UniversityStudent = "Estudiante universitario",
+    BachelorComplete = "Licenciatura completa",
+    Graduated = "Titulado",
+    Masters = "Maestr\u00EDa",
+    Doctorate = "Doctorado",
+    Other = "Otros"
+}
+/**
+ * Gender
+ *
+ * Gender identification for HR and demographic records.
+ */
+export declare enum Gender {
+    Male = "Masculino",
+    Female = "Femenino",
+    Other = "Otro"
+}

package/dist/constants/collaborator.constants.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * Collaborator Constants and Enums
+ *
+ * Shared enums used by both backend and frontend for collaborator management.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gender = exports.Degree = exports.WebAppRole = void 0;
+/**
+ * Web Application Roles
+ *
+ * Defines user roles for authorization and access control.
+ * Used in JWT tokens, middleware, and UI role-based rendering.
+ */
+var WebAppRole;
+(function (WebAppRole) {
+    WebAppRole["admin"] = "Administrador";
+    WebAppRole["manager"] = "Gerente";
+    WebAppRole["collaborator"] = "Colaborador";
+    WebAppRole["user"] = "User";
+    WebAppRole["guest"] = "Invitado";
+})(WebAppRole || (exports.WebAppRole = WebAppRole = {}));
+/**
+ * Educational Degree
+ *
+ * Academic level of collaborators for HR records.
+ */
+var Degree;
+(function (Degree) {
+    Degree["HighSchool"] = "Bachillerato";
+    Degree["UniversityStudent"] = "Estudiante universitario";
+    Degree["BachelorComplete"] = "Licenciatura completa";
+    Degree["Graduated"] = "Titulado";
+    Degree["Masters"] = "Maestr\u00EDa";
+    Degree["Doctorate"] = "Doctorado";
+    Degree["Other"] = "Otros";
+})(Degree || (exports.Degree = Degree = {}));
+/**
+ * Gender
+ *
+ * Gender identification for HR and demographic records.
+ */
+var Gender;
+(function (Gender) {
+    Gender["Male"] = "Masculino";
+    Gender["Female"] = "Femenino";
+    Gender["Other"] = "Otro";
+})(Gender || (exports.Gender = Gender = {}));

package/dist/constants/index.d.ts

@@ -3,3 +3,4 @@
  */
 export * from './mexican-states';
 export * from './sat-catalogs';
+export * from './collaborator.constants';

package/dist/constants/index.js

@@ -19,3 +19,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./mexican-states"), exports);
 __exportStar(require("./sat-catalogs"), exports);
+__exportStar(require("./collaborator.constants"), exports);

package/dist/contracts/collaborator/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Collaborator API Contracts
+ * Request and Response types for Collaborator endpoints
+ */
+export * from './responses';
+export * from './requests';

package/dist/contracts/collaborator/index.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * Collaborator API Contracts
+ * Request and Response types for Collaborator endpoints
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./responses"), exports);
+__exportStar(require("./requests"), exports);

package/dist/contracts/collaborator/requests.d.ts

@@ -0,0 +1,132 @@
+import { WebAppRole } from '../../constants/collaborator.constants';
+import { AddressValidationProps } from '../../validation/address.validation';
+/**
+ * Create Collaborator Request
+ *
+ * Data required to create a new collaborator.
+ * Used by admin/manager roles.
+ *
+ * @example POST /api/collaborators/create
+ */
+export interface CreateCollaboratorRequest {
+    first_name: string;
+    last_name: string;
+    col_code: string;
+    role: WebAppRole;
+    isActive: boolean;
+    isDisplayedWeb: boolean;
+    isRegistered: boolean;
+    second_last_name?: string;
+    email?: string;
+    phone?: string;
+    photoURL?: string;
+    birthDate?: string;
+    job?: string;
+    branch?: string;
+    startDate?: string;
+    hireDate?: string;
+    endDate?: string;
+    address?: AddressValidationProps;
+    facebook?: string;
+    instagram?: string;
+    rfcCode?: string;
+    curp?: string;
+    imssNumber?: string;
+    useFiscalAddressSameAsMain?: boolean;
+    fiscalAddress?: AddressValidationProps;
+    taxZipCode?: string;
+    contractType?: string;
+    regimeType?: string;
+    fiscalRegime?: string;
+    bank?: string;
+    bankAccount?: string;
+    baseSalary?: number;
+    dailySalary?: number;
+    accessCode?: string;
+    password?: string;
+}
+/**
+ * Update Collaborator Request
+ *
+ * Partial data to update an existing collaborator.
+ * All fields optional - only provided fields will be updated.
+ *
+ * @example PATCH /api/collaborators/:id
+ */
+export interface UpdateCollaboratorRequest {
+    first_name?: string;
+    last_name?: string;
+    second_last_name?: string;
+    email?: string;
+    phone?: string;
+    photoURL?: string;
+    birthDate?: string;
+    role?: WebAppRole;
+    isActive?: boolean;
+    isDisplayedWeb?: boolean;
+    isRegistered?: boolean;
+    job?: string;
+    branch?: string;
+    startDate?: string;
+    hireDate?: string;
+    endDate?: string;
+    address?: AddressValidationProps;
+    facebook?: string;
+    instagram?: string;
+    rfcCode?: string;
+    curp?: string;
+    imssNumber?: string;
+    useFiscalAddressSameAsMain?: boolean;
+    fiscalAddress?: AddressValidationProps;
+    taxZipCode?: string;
+    contractType?: string;
+    regimeType?: string;
+    fiscalRegime?: string;
+    bank?: string;
+    bankAccount?: string;
+    baseSalary?: number;
+    dailySalary?: number;
+    accessCode?: string;
+    password?: string;
+}
+/**
+ * Register Collaborator Request
+ *
+ * Public registration flow for collaborators.
+ * Collaborator provides col_code, accessCode, email and password to register.
+ *
+ * @example PATCH /api/collaborators/register
+ */
+export interface RegisterCollaboratorRequest {
+    col_code: string;
+    accessCode: string;
+    email: string;
+    password: string;
+}
+/**
+ * Update Many Collaborators Request
+ *
+ * Batch update multiple collaborators.
+ * Each item must include id + fields to update.
+ *
+ * @example PATCH /api/collaborators
+ */
+export interface UpdateManyCollaboratorsRequest {
+    collaborators: Array<{
+        id: string;
+    } & Partial<UpdateCollaboratorRequest>>;
+}
+/**
+ * Collaborator Query Filters
+ *
+ * Query parameters for filtering collaborators list.
+ *
+ * @example GET /api/collaborators?isActive=true&role=Colaborador
+ */
+export interface CollaboratorQueryFilters {
+    isActive?: boolean;
+    role?: WebAppRole;
+    branch?: string;
+    isRegistered?: boolean;
+    isDisplayedWeb?: boolean;
+}

package/dist/contracts/collaborator/requests.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/contracts/collaborator/responses.d.ts

@@ -0,0 +1,80 @@
+import { WebAppRole } from '../../constants/collaborator.constants';
+import { AddressValidationProps } from '../../validation/address.validation';
+/**
+ * Public Collaborator Response
+ *
+ * Minimal data for public endpoints (no authentication required).
+ * Used for: Public website, service listings, team pages.
+ *
+ * @example GET /api/collaborators/public
+ */
+export interface PublicCollaboratorResponse {
+    id: string;
+    col_code: string;
+    first_name: string;
+    last_name: string;
+    photoURL?: string;
+    role: WebAppRole;
+    isActive: boolean;
+}
+/**
+ * Collaborator View Response
+ *
+ * Extended data for authenticated collaborators viewing other collaborators.
+ * Excludes sensitive information (fiscal data, salary, banking).
+ *
+ * Used for: Collaborators viewing team members, scheduling, contact info.
+ *
+ * @example GET /api/collaborators/:id (authenticated collaborator)
+ */
+export interface CollaboratorViewResponse extends PublicCollaboratorResponse {
+    email?: string;
+    phone?: string;
+    birthDate?: string;
+    isDisplayedWeb: boolean;
+    isRegistered: boolean;
+    job?: string;
+    branch?: string;
+    startDate?: string;
+    hireDate?: string;
+    endDate?: string;
+    address?: AddressValidationProps;
+    facebook?: string;
+    instagram?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * Admin Collaborator Response
+ *
+ * Complete data including all sensitive information.
+ * Only for admin users.
+ *
+ * Used for: Admin dashboard, payroll management, HR operations, CFDI generation.
+ *
+ * @example GET /api/collaborators/:id (admin authenticated)
+ */
+export interface AdminCollaboratorResponse extends CollaboratorViewResponse {
+    second_last_name?: string;
+    registeredDate?: string;
+    rfcCode?: string;
+    curp?: string;
+    imssNumber?: string;
+    useFiscalAddressSameAsMain: boolean;
+    fiscalAddress?: AddressValidationProps;
+    taxZipCode?: string;
+    contractType?: string;
+    regimeType?: string;
+    fiscalRegime?: string;
+    bank?: string;
+    bankAccount?: string;
+    baseSalary?: number;
+    dailySalary?: number;
+    accessCode?: string;
+    createdBy?: string;
+    updatedBy?: string;
+}
+/**
+ * Union type for all collaborator response types
+ */
+export type CollaboratorResponse = PublicCollaboratorResponse | CollaboratorViewResponse | AdminCollaboratorResponse;

package/dist/contracts/collaborator/responses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/contracts/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * API Contracts
+ * Request and Response types for all API endpoints
+ */
+export * from './collaborator';

package/dist/contracts/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * API Contracts
+ * Request and Response types for all API endpoints
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./collaborator"), exports);

package/dist/index.d.ts

@@ -4,5 +4,6 @@
  */
 export * from './types';
 export * from './constants';
+export * from './contracts';
 export * from './validation';
 export { debugLog } from './utils/debug-logger';

package/dist/index.js

@@ -21,6 +21,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.debugLog = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./contracts"), exports);
 __exportStar(require("./validation"), exports);
 var debug_logger_1 = require("./utils/debug-logger");
 Object.defineProperty(exports, "debugLog", { enumerable: true, get: function () { return debug_logger_1.debugLog; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hvp-shared",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "description": "Shared types and utilities for HVP backend and frontend",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",