hvp-shared 6.35.0 → 6.37.0

package/dist/constants/index.d.ts

@@ -11,3 +11,5 @@ export * from './qvet-catalog';
 export * from './qvet-warehouses';
 export * from './qvet-inventory';
 export * from './background-job.constants';
+export * from './job-category.constants';
+export * from './special-collaborators.constants';

package/dist/constants/index.js

@@ -27,3 +27,5 @@ __exportStar(require("./qvet-catalog"), exports);
 __exportStar(require("./qvet-warehouses"), exports);
 __exportStar(require("./qvet-inventory"), exports);
 __exportStar(require("./background-job.constants"), exports);
+__exportStar(require("./job-category.constants"), exports);
+__exportStar(require("./special-collaborators.constants"), exports);

package/dist/constants/job-category.constants.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Job Category Constants
+ *
+ * Enum and groupings for classifying jobs by function.
+ * Used by shift validations and business rules instead of comparing job titles.
+ *
+ * @example
+ * // Check if a job is veterinary staff
+ * VET_CATEGORIES.includes(job.category)
+ */
+/**
+ * Functional category for a job position.
+ *
+ * Decouples business logic from job titles so titles can be renamed
+ * without breaking shift validations or other rules.
+ */
+export declare enum JobCategory {
+    MEDICAL_DIRECTOR = "MEDICAL_DIRECTOR",
+    VET = "VET",
+    VET_ASSISTANT = "VET_ASSISTANT",
+    TRAINEE = "TRAINEE",
+    RECEPTIONIST = "RECEPTIONIST",
+    ADMIN = "ADMIN",
+    ADVISOR = "ADVISOR"
+}
+/**
+ * Jobs that count as veterinarians for shift coverage rules.
+ * Includes directors and full vets.
+ */
+export declare const VET_CATEGORIES: readonly JobCategory[];
+/**
+ * All medical/clinical staff — vets + assistants + trainees.
+ * Used for total clinical headcount validations.
+ */
+export declare const ALL_MEDICAL_CATEGORIES: readonly JobCategory[];

package/dist/constants/job-category.constants.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * Job Category Constants
+ *
+ * Enum and groupings for classifying jobs by function.
+ * Used by shift validations and business rules instead of comparing job titles.
+ *
+ * @example
+ * // Check if a job is veterinary staff
+ * VET_CATEGORIES.includes(job.category)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALL_MEDICAL_CATEGORIES = exports.VET_CATEGORIES = exports.JobCategory = void 0;
+/**
+ * Functional category for a job position.
+ *
+ * Decouples business logic from job titles so titles can be renamed
+ * without breaking shift validations or other rules.
+ */
+var JobCategory;
+(function (JobCategory) {
+    JobCategory["MEDICAL_DIRECTOR"] = "MEDICAL_DIRECTOR";
+    JobCategory["VET"] = "VET";
+    JobCategory["VET_ASSISTANT"] = "VET_ASSISTANT";
+    JobCategory["TRAINEE"] = "TRAINEE";
+    JobCategory["RECEPTIONIST"] = "RECEPTIONIST";
+    JobCategory["ADMIN"] = "ADMIN";
+    JobCategory["ADVISOR"] = "ADVISOR";
+})(JobCategory || (exports.JobCategory = JobCategory = {}));
+/**
+ * Jobs that count as veterinarians for shift coverage rules.
+ * Includes directors and full vets.
+ */
+exports.VET_CATEGORIES = [
+    JobCategory.MEDICAL_DIRECTOR,
+    JobCategory.VET,
+];
+/**
+ * All medical/clinical staff — vets + assistants + trainees.
+ * Used for total clinical headcount validations.
+ */
+exports.ALL_MEDICAL_CATEGORIES = [
+    ...exports.VET_CATEGORIES,
+    JobCategory.VET_ASSISTANT,
+    JobCategory.TRAINEE,
+];

package/dist/constants/special-collaborators.constants.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Special Collaborator Constants
+ *
+ * Codes for collaborators that have special shift validation rules.
+ * Replaces hardcoded "MAT" / "RGL" strings in frontend helpers.
+ */
+/**
+ * Collaborator codes that are exempt from certain shift coverage rules
+ * (e.g., they may work supervised shifts without full vet coverage).
+ */
+export declare const SUPERVISED_COLLABORATOR_CODES: readonly ["MAT", "RGL"];
+export type SupervisedCollaboratorCode = (typeof SUPERVISED_COLLABORATOR_CODES)[number];

package/dist/constants/special-collaborators.constants.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Special Collaborator Constants
+ *
+ * Codes for collaborators that have special shift validation rules.
+ * Replaces hardcoded "MAT" / "RGL" strings in frontend helpers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPERVISED_COLLABORATOR_CODES = void 0;
+/**
+ * Collaborator codes that are exempt from certain shift coverage rules
+ * (e.g., they may work supervised shifts without full vet coverage).
+ */
+exports.SUPERVISED_COLLABORATOR_CODES = ["MAT", "RGL"];

package/dist/types/index.d.ts

@@ -10,3 +10,4 @@ export * from './sync-field.types';
 export * from './catalog-item.types';
 export * from './qvet.types';
 export * from './background-job.types';
+export * from './payroll-v2.types';

package/dist/types/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./sync-field.types"), exports);
 __exportStar(require("./catalog-item.types"), exports);
 __exportStar(require("./qvet.types"), exports);
 __exportStar(require("./background-job.types"), exports);
+__exportStar(require("./payroll-v2.types"), exports);

package/dist/types/payroll-v2.types.d.ts

@@ -0,0 +1,115 @@
+/**
+ * PayrollV2 Types — unified PayrollItem-based model.
+ *
+ * Each item is self-describing: carries SAT codes, taxed/exempt split,
+ * source key for internal reference, and an optional formula explaining
+ * how the amount was calculated.
+ *
+ * NOTE: CfdiStatus and PayrollStatus enums are NOT imported here because
+ * they live in repo-specific enum files (used in 19+ files each). Instead,
+ * the `status` and `payrollStatus` fields use `string`, which is compatible
+ * since TypeScript string enum values ARE strings.
+ */
+export declare enum PayrollItemCategory {
+    BASE_SALARY = "BASE_SALARY",
+    ADDITIONAL_FIXED = "ADDITIONAL_FIXED",
+    COMMISSION = "COMMISSION",
+    BONUS = "BONUS",
+    OVERTIME = "OVERTIME",
+    HOLIDAY_PAY = "HOLIDAY_PAY",
+    YEAR_END_BONUS = "YEAR_END_BONUS",
+    VACATION_BONUS = "VACATION_BONUS",
+    PROFIT_SHARING = "PROFIT_SHARING",
+    SUBSIDY = "SUBSIDY",
+    SUPPORT = "SUPPORT",
+    COMPENSATION = "COMPENSATION",
+    TAX = "TAX",
+    SOCIAL_SECURITY = "SOCIAL_SECURITY",
+    ATTENDANCE_DISCOUNT = "ATTENDANCE_DISCOUNT",
+    OTHER_DEDUCTION = "OTHER_DEDUCTION",
+    OTHER_PAYMENT = "OTHER_PAYMENT"
+}
+export interface PayrollFormula {
+    readonly expression: string;
+    readonly inputs: Record<string, number>;
+    readonly result: number;
+}
+export interface PayrollItem {
+    readonly satCode?: string;
+    readonly satType?: string;
+    readonly description: string;
+    readonly amount: number;
+    readonly taxedAmount?: number;
+    readonly exemptAmount?: number;
+    readonly sourceKey: string;
+    readonly category: PayrollItemCategory;
+    readonly formula?: PayrollFormula;
+    readonly isEditable: boolean;
+    readonly notes?: string;
+}
+export interface PayrollV2Totals {
+    readonly totalPerceptions: number;
+    readonly totalDeductions: number;
+    readonly totalOtherPayments: number;
+    readonly totalTaxed: number;
+    readonly totalExempt: number;
+    readonly netPay: number;
+}
+export interface PayrollCalculationContext {
+    readonly attendanceFactor?: number;
+    readonly dailyUma: number;
+    readonly isrBracketUsed?: string;
+    readonly subsidioCausado?: number;
+    readonly isrCausado?: number;
+    readonly employerImssRate?: number;
+    readonly workedHours: number;
+    readonly hourlyRate?: number;
+}
+export interface PayrollEmployeeSnapshot {
+    readonly fullName: string;
+    readonly collaboratorCode: string;
+    readonly imgUrl?: string;
+    readonly curp?: string;
+    readonly rfc?: string;
+    readonly socialSecurityNumber?: string;
+    readonly jobTitle: string;
+    readonly paymentType: string;
+    readonly contributionBaseSalary: number;
+    readonly fiscalRegime?: string;
+    readonly taxZipCode?: string;
+    readonly startDateLaborRelations?: string;
+    readonly contractType?: string;
+    readonly regimeType?: string;
+    readonly federalEntityKey?: string;
+    readonly bank?: string;
+    readonly bankAccount?: string;
+    readonly typeOfJourney?: string;
+    readonly frequencyPayment?: string;
+    readonly positionRisk?: string;
+}
+export interface PayrollV2Cfdi {
+    /** CfdiStatus value — typed as string to avoid coupling to repo-specific enums */
+    readonly status: string;
+    readonly uuid?: string;
+    readonly facturamaId?: string;
+    readonly stampedAt?: Date | string;
+    readonly cancelledAt?: Date | string;
+    readonly errorMessage?: string;
+}
+export interface PayrollV2 {
+    readonly collaboratorId?: string;
+    readonly employmentId?: string;
+    readonly jobId?: string;
+    readonly periodStartDate?: string;
+    readonly periodEndDate?: string;
+    /** PayrollStatus value — typed as string to avoid coupling to repo-specific enums */
+    readonly payrollStatus?: string;
+    readonly daysPaid?: number;
+    readonly perceptions: PayrollItem[];
+    readonly deductions: PayrollItem[];
+    readonly otherPayments: PayrollItem[];
+    readonly totals: PayrollV2Totals;
+    readonly employee: PayrollEmployeeSnapshot;
+    readonly calculationContext: PayrollCalculationContext;
+    readonly cfdi?: PayrollV2Cfdi;
+}

package/dist/types/payroll-v2.types.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * PayrollV2 Types — unified PayrollItem-based model.
+ *
+ * Each item is self-describing: carries SAT codes, taxed/exempt split,
+ * source key for internal reference, and an optional formula explaining
+ * how the amount was calculated.
+ *
+ * NOTE: CfdiStatus and PayrollStatus enums are NOT imported here because
+ * they live in repo-specific enum files (used in 19+ files each). Instead,
+ * the `status` and `payrollStatus` fields use `string`, which is compatible
+ * since TypeScript string enum values ARE strings.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayrollItemCategory = void 0;
+// ============================================================
+// Core item types
+// ============================================================
+var PayrollItemCategory;
+(function (PayrollItemCategory) {
+    PayrollItemCategory["BASE_SALARY"] = "BASE_SALARY";
+    PayrollItemCategory["ADDITIONAL_FIXED"] = "ADDITIONAL_FIXED";
+    PayrollItemCategory["COMMISSION"] = "COMMISSION";
+    PayrollItemCategory["BONUS"] = "BONUS";
+    PayrollItemCategory["OVERTIME"] = "OVERTIME";
+    PayrollItemCategory["HOLIDAY_PAY"] = "HOLIDAY_PAY";
+    PayrollItemCategory["YEAR_END_BONUS"] = "YEAR_END_BONUS";
+    PayrollItemCategory["VACATION_BONUS"] = "VACATION_BONUS";
+    PayrollItemCategory["PROFIT_SHARING"] = "PROFIT_SHARING";
+    PayrollItemCategory["SUBSIDY"] = "SUBSIDY";
+    PayrollItemCategory["SUPPORT"] = "SUPPORT";
+    PayrollItemCategory["COMPENSATION"] = "COMPENSATION";
+    PayrollItemCategory["TAX"] = "TAX";
+    PayrollItemCategory["SOCIAL_SECURITY"] = "SOCIAL_SECURITY";
+    PayrollItemCategory["ATTENDANCE_DISCOUNT"] = "ATTENDANCE_DISCOUNT";
+    PayrollItemCategory["OTHER_DEDUCTION"] = "OTHER_DEDUCTION";
+    PayrollItemCategory["OTHER_PAYMENT"] = "OTHER_PAYMENT";
+})(PayrollItemCategory || (exports.PayrollItemCategory = PayrollItemCategory = {}));

package/package.json

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