@t4dhg/mcp-factorial 1.1.0 → 3.0.0

package/dist/schemas.js

@@ -0,0 +1,718 @@
+/**
+ * Zod schemas for runtime validation of API responses
+ *
+ * Catches API version mismatches and ensures type safety at runtime.
+ */
+import { z } from 'zod';
+import { SchemaValidationError } from './errors.js';
+/**
+ * Employee schema
+ */
+export const EmployeeSchema = z.object({
+    id: z.number(),
+    first_name: z.string().nullable(),
+    last_name: z.string().nullable(),
+    full_name: z.string().nullable(),
+    email: z.string().nullable(),
+    birthday_on: z.string().nullable(),
+    hired_on: z.string().nullable(),
+    start_date: z.string().nullable(),
+    terminated_on: z.string().nullable(),
+    gender: z.string().nullable(),
+    nationality: z.string().nullable(),
+    manager_id: z.number().nullable(),
+    role: z.string().nullable(),
+    timeoff_manager_id: z.number().nullable(),
+    company_id: z.number().nullable(),
+    legal_entity_id: z.number().nullable(),
+    team_ids: z.array(z.number()).default([]),
+    location_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Team schema
+ */
+export const TeamSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    description: z.string().nullable(),
+    company_id: z.number().nullable(),
+    employee_ids: z.array(z.number()).default([]),
+    lead_ids: z.array(z.number()).default([]),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Location schema
+ */
+export const LocationSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    country: z.string().nullable(),
+    phone_number: z.string().nullable(),
+    state: z.string().nullable(),
+    city: z.string().nullable(),
+    address_line_1: z.string().nullable(),
+    address_line_2: z.string().nullable(),
+    postal_code: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Contract schema
+ */
+export const ContractSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    job_title: z.string().nullable(),
+    effective_on: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Leave schema
+ */
+export const LeaveSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    leave_type_id: z.number(),
+    start_on: z.string(),
+    finish_on: z.string(),
+    half_day: z.enum(['all_day', 'start', 'finish']).nullable(),
+    status: z.enum(['pending', 'approved', 'declined']),
+    description: z.string().nullable(),
+    deleted_at: z.string().nullable(),
+    duration_attributes: z
+        .object({
+        days: z.number(),
+        hours: z.number(),
+    })
+        .nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Leave type schema
+ */
+export const LeaveTypeSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    code: z.string().nullable(),
+    color: z.string().nullable(),
+    description: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Allowance schema
+ */
+export const AllowanceSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    leave_type_id: z.number(),
+    policy_id: z.number().nullable(),
+    balance_days: z.number(),
+    consumed_days: z.number(),
+    available_days: z.number(),
+    valid_from: z.string().nullable(),
+    valid_to: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Shift schema
+ */
+export const ShiftSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    clock_in: z.string(),
+    clock_out: z.string().nullable(),
+    worked_hours: z.number().nullable(),
+    break_minutes: z.number().nullable(),
+    location: z.string().nullable(),
+    notes: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Folder schema
+ */
+export const FolderSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    parent_id: z.number().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Document schema
+ */
+export const DocumentSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    folder_id: z.number().nullable(),
+    author_id: z.number().nullable(),
+    company_id: z.number().nullable(),
+    public: z.boolean().default(false),
+    space: z.string().nullable(),
+    file_url: z.string().nullable(),
+    mime_type: z.string().nullable(),
+    size_bytes: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Job role schema
+ */
+export const JobRoleSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    description: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Job level schema
+ */
+export const JobLevelSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    description: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+// ============================================================================
+// Write Input Schemas (for create/update operations)
+// ============================================================================
+/**
+ * Date string pattern (YYYY-MM-DD)
+ */
+const datePattern = /^\d{4}-\d{2}-\d{2}$/;
+const dateString = z.string().regex(datePattern, 'Date must be in YYYY-MM-DD format');
+/**
+ * Employee create input schema
+ */
+export const CreateEmployeeInputSchema = z.object({
+    first_name: z.string().min(1).max(100),
+    last_name: z.string().min(1).max(100),
+    email: z.string().email(),
+    birthday_on: dateString.optional(),
+    hired_on: dateString.optional(),
+    start_date: dateString.optional(),
+    gender: z.enum(['male', 'female', 'other']).optional(),
+    nationality: z.string().max(50).optional(),
+    manager_id: z.number().positive().optional(),
+    role: z.string().max(100).optional(),
+    team_ids: z.array(z.number().positive()).optional(),
+    location_id: z.number().positive().optional(),
+});
+/**
+ * Employee update input schema (all fields optional)
+ */
+export const UpdateEmployeeInputSchema = CreateEmployeeInputSchema.partial();
+/**
+ * Employee termination input schema
+ */
+export const TerminateEmployeeInputSchema = z.object({
+    terminated_on: dateString,
+    reason: z.string().max(500).optional(),
+});
+/**
+ * Team create input schema
+ */
+export const CreateTeamInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    description: z.string().max(500).optional(),
+    lead_ids: z.array(z.number().positive()).optional(),
+    employee_ids: z.array(z.number().positive()).optional(),
+});
+/**
+ * Team update input schema
+ */
+export const UpdateTeamInputSchema = CreateTeamInputSchema.partial();
+/**
+ * Location create input schema
+ */
+export const CreateLocationInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    country: z.string().max(50).optional(),
+    state: z.string().max(50).optional(),
+    city: z.string().max(50).optional(),
+    address_line_1: z.string().max(200).optional(),
+    address_line_2: z.string().max(200).optional(),
+    postal_code: z.string().max(20).optional(),
+    phone_number: z.string().max(30).optional(),
+});
+/**
+ * Location update input schema
+ */
+export const UpdateLocationInputSchema = CreateLocationInputSchema.partial();
+/**
+ * Leave create input schema
+ */
+export const CreateLeaveInputSchema = z.object({
+    employee_id: z.number().positive(),
+    leave_type_id: z.number().positive(),
+    start_on: dateString,
+    finish_on: dateString,
+    half_day: z.enum(['all_day', 'start', 'finish']).optional(),
+    description: z.string().max(500).optional(),
+});
+/**
+ * Leave update input schema
+ */
+export const UpdateLeaveInputSchema = CreateLeaveInputSchema.partial().omit({ employee_id: true });
+/**
+ * Leave approval/rejection input schema
+ */
+export const LeaveDecisionInputSchema = z.object({
+    reason: z.string().max(500).optional(),
+});
+/**
+ * Shift create input schema
+ */
+export const CreateShiftInputSchema = z.object({
+    employee_id: z.number().positive(),
+    clock_in: z.string().datetime(),
+    clock_out: z.string().datetime().optional(),
+    break_minutes: z.number().min(0).max(480).optional(),
+    location: z.string().max(200).optional(),
+    notes: z.string().max(500).optional(),
+});
+/**
+ * Shift update input schema
+ */
+export const UpdateShiftInputSchema = CreateShiftInputSchema.partial().omit({ employee_id: true });
+// ============================================================================
+// New Entity Schemas (Projects, Training, ATS, Work Areas, Payroll)
+// ============================================================================
+/**
+ * Project schema
+ */
+export const ProjectSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    code: z.string().nullable(),
+    description: z.string().nullable(),
+    status: z.enum(['active', 'inactive', 'archived']).nullable(),
+    employees_assignment: z.enum(['manual', 'company']).nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Project create input schema
+ */
+export const CreateProjectInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    code: z.string().max(20).optional(),
+    description: z.string().max(500).optional(),
+    employees_assignment: z.enum(['manual', 'company']).optional(),
+});
+/**
+ * Project update input schema
+ */
+export const UpdateProjectInputSchema = CreateProjectInputSchema.partial().extend({
+    status: z.enum(['active', 'inactive', 'archived']).optional(),
+});
+/**
+ * Project Task schema
+ */
+export const ProjectTaskSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    project_id: z.number(),
+    subproject_id: z.number().nullable(),
+    description: z.string().nullable(),
+    completed: z.boolean().default(false),
+    due_on: z.string().nullable(),
+    due_status: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Project Task create input schema
+ */
+export const CreateProjectTaskInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    project_id: z.number().positive(),
+    description: z.string().max(500).optional(),
+    due_on: dateString.optional(),
+});
+/**
+ * Project Task update input schema
+ */
+export const UpdateProjectTaskInputSchema = CreateProjectTaskInputSchema.partial()
+    .omit({ project_id: true })
+    .extend({
+    completed: z.boolean().optional(),
+});
+/**
+ * Project Worker schema
+ */
+export const ProjectWorkerSchema = z.object({
+    id: z.number(),
+    project_id: z.number(),
+    employee_id: z.number(),
+    company_labor_cost_cents: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Project Worker assign input schema
+ */
+export const AssignProjectWorkerInputSchema = z.object({
+    project_id: z.number().positive(),
+    employee_id: z.number().positive(),
+});
+/**
+ * Time Record schema
+ */
+export const TimeRecordSchema = z.object({
+    id: z.number(),
+    project_worker_id: z.number(),
+    subproject_id: z.number().nullable(),
+    attendance_shift_id: z.number().nullable(),
+    minutes: z.number(),
+    date: z.string(),
+    description: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Time Record create input schema
+ */
+export const CreateTimeRecordInputSchema = z.object({
+    project_worker_id: z.number().positive(),
+    date: dateString,
+    minutes: z.number().min(1).max(1440),
+    description: z.string().max(500).optional(),
+});
+/**
+ * Time Record update input schema
+ */
+export const UpdateTimeRecordInputSchema = CreateTimeRecordInputSchema.partial().omit({
+    project_worker_id: true,
+});
+/**
+ * Training schema
+ */
+export const TrainingSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    description: z.string().nullable(),
+    category_id: z.number().nullable(),
+    status: z.string().nullable(),
+    subsidized: z.boolean().nullable(),
+    total_training_indirect_cost: z.number().nullable(),
+    total_training_salary_cost: z.number().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Training create input schema
+ */
+export const CreateTrainingInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    description: z.string().max(1000).optional(),
+    category_id: z.number().positive().optional(),
+    subsidized: z.boolean().optional(),
+});
+/**
+ * Training update input schema
+ */
+export const UpdateTrainingInputSchema = CreateTrainingInputSchema.partial();
+/**
+ * Training Session schema
+ */
+export const TrainingSessionSchema = z.object({
+    id: z.number(),
+    training_id: z.number(),
+    name: z.string().nullable(),
+    start_date: z.string().nullable(),
+    end_date: z.string().nullable(),
+    location: z.string().nullable(),
+    max_attendees: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Training Session create input schema
+ */
+export const CreateTrainingSessionInputSchema = z.object({
+    training_id: z.number().positive(),
+    name: z.string().max(100).optional(),
+    start_date: dateString.optional(),
+    end_date: dateString.optional(),
+    location: z.string().max(200).optional(),
+    max_attendees: z.number().positive().optional(),
+});
+/**
+ * Training Session update input schema
+ */
+export const UpdateTrainingSessionInputSchema = CreateTrainingSessionInputSchema.partial().omit({
+    training_id: true,
+});
+/**
+ * Training Membership (Enrollment) schema
+ */
+export const TrainingMembershipSchema = z.object({
+    id: z.number(),
+    training_id: z.number(),
+    employee_id: z.number(),
+    session_id: z.number().nullable(),
+    status: z.string().nullable(),
+    enrolled_at: z.string().nullable(),
+    completed_at: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Training enrollment input schema
+ */
+export const EnrollTrainingInputSchema = z.object({
+    training_id: z.number().positive(),
+    employee_id: z.number().positive(),
+    session_id: z.number().positive().optional(),
+});
+/**
+ * Work Area schema
+ */
+export const WorkAreaSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    description: z.string().nullable(),
+    location_id: z.number().nullable(),
+    company_id: z.number().nullable(),
+    archived: z.boolean().default(false),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Work Area create input schema
+ */
+export const CreateWorkAreaInputSchema = z.object({
+    name: z.string().min(1).max(100),
+    description: z.string().max(500).optional(),
+    location_id: z.number().positive().optional(),
+});
+/**
+ * Work Area update input schema
+ */
+export const UpdateWorkAreaInputSchema = CreateWorkAreaInputSchema.partial();
+/**
+ * Job Posting schema
+ */
+export const JobPostingSchema = z.object({
+    id: z.number(),
+    title: z.string(),
+    description: z.string().nullable(),
+    department: z.string().nullable(),
+    location_id: z.number().nullable(),
+    team_id: z.number().nullable(),
+    status: z.enum(['draft', 'published', 'closed', 'archived']).nullable(),
+    employment_type: z.string().nullable(),
+    remote_status: z.string().nullable(),
+    company_id: z.number().nullable(),
+    published_at: z.string().nullable(),
+    closed_at: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Job Posting create input schema
+ */
+export const CreateJobPostingInputSchema = z.object({
+    title: z.string().min(1).max(200),
+    description: z.string().max(5000).optional(),
+    department: z.string().max(100).optional(),
+    location_id: z.number().positive().optional(),
+    team_id: z.number().positive().optional(),
+    employment_type: z.string().max(50).optional(),
+    remote_status: z.string().max(50).optional(),
+});
+/**
+ * Job Posting update input schema
+ */
+export const UpdateJobPostingInputSchema = CreateJobPostingInputSchema.partial().extend({
+    status: z.enum(['draft', 'published', 'closed', 'archived']).optional(),
+});
+/**
+ * Candidate schema
+ */
+export const CandidateSchema = z.object({
+    id: z.number(),
+    first_name: z.string().nullable(),
+    last_name: z.string().nullable(),
+    full_name: z.string().nullable(),
+    email: z.string().nullable(),
+    phone: z.string().nullable(),
+    source: z.string().nullable(),
+    resume_url: z.string().nullable(),
+    linkedin_url: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Candidate create input schema
+ */
+export const CreateCandidateInputSchema = z.object({
+    first_name: z.string().min(1).max(100),
+    last_name: z.string().min(1).max(100),
+    email: z.string().email().optional(),
+    phone: z.string().max(30).optional(),
+    source: z.string().max(100).optional(),
+    linkedin_url: z.string().url().optional(),
+});
+/**
+ * Candidate update input schema
+ */
+export const UpdateCandidateInputSchema = CreateCandidateInputSchema.partial();
+/**
+ * Application schema
+ */
+export const ApplicationSchema = z.object({
+    id: z.number(),
+    job_posting_id: z.number(),
+    candidate_id: z.number(),
+    hiring_stage_id: z.number().nullable(),
+    ats_application_phase_id: z.number().nullable(),
+    status: z.string().nullable(),
+    rating: z.number().nullable(),
+    notes: z.string().nullable(),
+    applied_at: z.string().nullable(),
+    rejected_at: z.string().nullable(),
+    hired_at: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Application create input schema
+ */
+export const CreateApplicationInputSchema = z.object({
+    job_posting_id: z.number().positive(),
+    candidate_id: z.number().positive(),
+    notes: z.string().max(2000).optional(),
+});
+/**
+ * Application update input schema
+ */
+export const UpdateApplicationInputSchema = z.object({
+    hiring_stage_id: z.number().positive().optional(),
+    rating: z.number().min(0).max(5).optional(),
+    notes: z.string().max(2000).optional(),
+});
+/**
+ * Hiring Stage schema
+ */
+export const HiringStageSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    label: z.string().nullable(),
+    ats_application_phase_id: z.number().nullable(),
+    position: z.number().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Payroll Supplement schema
+ */
+export const PayrollSupplementSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    supplement_type_id: z.number().nullable(),
+    name: z.string().nullable(),
+    amount_cents: z.number().nullable(),
+    effective_on: z.string().nullable(),
+    company_id: z.number().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Tax Identifier schema
+ */
+export const TaxIdentifierSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    identifier_type: z.string().nullable(),
+    identifier_value: z.string().nullable(),
+    country: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+/**
+ * Family Situation schema
+ */
+export const FamilySituationSchema = z.object({
+    id: z.number(),
+    employee_id: z.number(),
+    marital_status: z.string().nullable(),
+    number_of_dependents: z.number().nullable(),
+    effective_on: z.string().nullable(),
+    created_at: z.string().nullable(),
+    updated_at: z.string().nullable(),
+});
+// ============================================================================
+// API Response Helpers
+// ============================================================================
+/**
+ * API response wrapper schema
+ */
+export function createApiResponseSchema(dataSchema) {
+    return z.object({
+        data: dataSchema,
+    });
+}
+/**
+ * API list response wrapper schema
+ */
+export function createApiListResponseSchema(itemSchema) {
+    return z.object({
+        data: z.array(itemSchema),
+    });
+}
+/**
+ * Parse and validate data against a schema
+ * @throws SchemaValidationError if validation fails
+ */
+export function parseData(schemaName, schema, data) {
+    const result = schema.safeParse(data);
+    if (!result.success) {
+        const issues = result.error.issues.map(i => `${i.path.join('.')}: ${i.message}`).join(', ');
+        throw new SchemaValidationError(schemaName, issues, { data });
+    }
+    return result.data;
+}
+/**
+ * Safely parse data without throwing (returns undefined on failure)
+ */
+export function safeParseData(schema, data) {
+    const result = schema.safeParse(data);
+    return result.success ? result.data : undefined;
+}
+/**
+ * Parse an array of items against a schema
+ */
+export function parseArray(schemaName, itemSchema, data) {
+    if (!Array.isArray(data)) {
+        throw new SchemaValidationError(schemaName, 'Expected an array', { data });
+    }
+    return data.map((item, index) => {
+        const result = itemSchema.safeParse(item);
+        if (!result.success) {
+            const issues = result.error.issues.map(i => `${i.path.join('.')}: ${i.message}`).join(', ');
+            throw new SchemaValidationError(`${schemaName}[${index}]`, issues, { item });
+        }
+        return result.data;
+    });
+}
+//# sourceMappingURL=schemas.js.map