@feedmepos/mf-hrm-portal 2.3.2-dev → 2.3.2-dev.10

package/dist/src/views/scheduling/schedule-state.d.ts

@@ -0,0 +1,767 @@
+import type { IFdtoPosUserSummary } from '@/types/employee';
+import type { CompGroupMeta, ExistingStaffCandidate, ShiftTemplate } from './types';
+/**
+ * The single mutable state boundary for Scheduling.
+ *
+ * API orchestration lives in schedule-store.ts and view-model projections live in data.ts,
+ * but both write through this object. Keeping the identities here prevents a page reload,
+ * outlet switch, or background roster refresh from leaving one module with stale containers.
+ */
+export declare const scheduleState: {
+    payload: import("vue").ShallowRef<{
+        timeOff: {
+            type: "OFF_DAY" | "LEAVE";
+            status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED";
+            employeeId: string;
+            id: string;
+            leaveType: "UNPAID" | "ANNUAL" | "MEDICAL" | "EMERGENCY" | null;
+            startDate: string;
+            endDate: string;
+            startPart: "FULL_DAY" | "AM" | "PM";
+            endPart: "FULL_DAY" | "AM" | "PM";
+            reason: string;
+            attachmentIds: string[];
+            requestedBy: string;
+            requestedAt: string;
+            approvedBy: string | null;
+            approvedAt: string | null;
+            approvalComment: string | null;
+        }[];
+        outlet: {
+            id: string;
+            name: string;
+        };
+        range: {
+            from: string;
+            to: string;
+        };
+        days: {
+            date: string;
+            id: string;
+            updatedAt: string;
+            isPublicHoliday: boolean;
+            title: string;
+            description: string;
+            salesForecastOverride: number | null;
+        }[];
+        demands: {
+            date: string | null;
+            startTime: string;
+            endTime: string;
+            id: string;
+            dayOfWeek: number | null;
+            position: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            headcount: number;
+        }[];
+        assignments: {
+            status: "DRAFT" | "PUBLISHED" | "CONFIRMED";
+            date: string;
+            startTime: string;
+            endTime: string;
+            employeeId: string;
+            id: string;
+            position: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            breaks: ({
+                type: "DURATION";
+                minutes: number;
+                breakPayType: "PAID" | "UNPAID";
+            } | {
+                type: "TIME_RANGE";
+                breakPayType: "PAID" | "UNPAID";
+                startTime: string;
+                endTime: string;
+            })[];
+            updatedAt: string;
+        }[];
+        positions: {
+            id: string;
+            name: string;
+        }[];
+        employees: {
+            minHoursPerDay?: number | null | undefined;
+            overtime?: {
+                maxHoursPerMonth: number | null;
+            } | undefined;
+            workingHours?: {
+                minHoursPerDay: number | null;
+                maxHoursPerDay: number | null;
+                maxHoursPerWeek: number | null;
+            } | undefined;
+            employeeId: string;
+            name: string;
+            employmentType: "FULLTIME" | "PARTTIME";
+            wage: {
+                type: "HOURLY" | "MONTHLY";
+                amount: number;
+            };
+            primaryPosition: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            secondaryPositions: {
+                positionId: string;
+                positionName: string;
+            }[];
+            availability: {
+                dayOfWeek: number;
+                start: string;
+                end: string;
+            }[];
+        }[];
+        settings: {
+            settingsConfigured?: boolean | undefined;
+            overtime: {
+                maxHoursPerMonth: number | null;
+            };
+            payRate: {
+                NORMAL: {
+                    overtime: number;
+                };
+                REST_DAY: {
+                    overtime: number;
+                    regular: number;
+                };
+                PUBLIC_HOLIDAY: {
+                    overtime: number;
+                    regular: number;
+                };
+            };
+            setupCompleted: boolean;
+            workingHours: {
+                minHoursPerDay: number | null;
+                maxHoursPerDay: number | null;
+                maxHoursPerWeek: number | null;
+            };
+        };
+        restaurantProfile: {
+            operatingHours: {
+                hours: {
+                    start: string;
+                    end: string;
+                }[];
+                dayOfWeek: number;
+                closed: boolean;
+            }[];
+        };
+    } | null, {
+        timeOff: {
+            type: "OFF_DAY" | "LEAVE";
+            status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED";
+            employeeId: string;
+            id: string;
+            leaveType: "UNPAID" | "ANNUAL" | "MEDICAL" | "EMERGENCY" | null;
+            startDate: string;
+            endDate: string;
+            startPart: "FULL_DAY" | "AM" | "PM";
+            endPart: "FULL_DAY" | "AM" | "PM";
+            reason: string;
+            attachmentIds: string[];
+            requestedBy: string;
+            requestedAt: string;
+            approvedBy: string | null;
+            approvedAt: string | null;
+            approvalComment: string | null;
+        }[];
+        outlet: {
+            id: string;
+            name: string;
+        };
+        range: {
+            from: string;
+            to: string;
+        };
+        days: {
+            date: string;
+            id: string;
+            updatedAt: string;
+            isPublicHoliday: boolean;
+            title: string;
+            description: string;
+            salesForecastOverride: number | null;
+        }[];
+        demands: {
+            date: string | null;
+            startTime: string;
+            endTime: string;
+            id: string;
+            dayOfWeek: number | null;
+            position: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            headcount: number;
+        }[];
+        assignments: {
+            status: "DRAFT" | "PUBLISHED" | "CONFIRMED";
+            date: string;
+            startTime: string;
+            endTime: string;
+            employeeId: string;
+            id: string;
+            position: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            breaks: ({
+                type: "DURATION";
+                minutes: number;
+                breakPayType: "PAID" | "UNPAID";
+            } | {
+                type: "TIME_RANGE";
+                breakPayType: "PAID" | "UNPAID";
+                startTime: string;
+                endTime: string;
+            })[];
+            updatedAt: string;
+        }[];
+        positions: {
+            id: string;
+            name: string;
+        }[];
+        employees: {
+            minHoursPerDay?: number | null | undefined;
+            overtime?: {
+                maxHoursPerMonth: number | null;
+            } | undefined;
+            workingHours?: {
+                minHoursPerDay: number | null;
+                maxHoursPerDay: number | null;
+                maxHoursPerWeek: number | null;
+            } | undefined;
+            employeeId: string;
+            name: string;
+            employmentType: "FULLTIME" | "PARTTIME";
+            wage: {
+                type: "HOURLY" | "MONTHLY";
+                amount: number;
+            };
+            primaryPosition: {
+                positionId: string;
+                positionName: string;
+            } | null;
+            secondaryPositions: {
+                positionId: string;
+                positionName: string;
+            }[];
+            availability: {
+                dayOfWeek: number;
+                start: string;
+                end: string;
+            }[];
+        }[];
+        settings: {
+            settingsConfigured?: boolean | undefined;
+            overtime: {
+                maxHoursPerMonth: number | null;
+            };
+            payRate: {
+                NORMAL: {
+                    overtime: number;
+                };
+                REST_DAY: {
+                    overtime: number;
+                    regular: number;
+                };
+                PUBLIC_HOLIDAY: {
+                    overtime: number;
+                    regular: number;
+                };
+            };
+            setupCompleted: boolean;
+            workingHours: {
+                minHoursPerDay: number | null;
+                maxHoursPerDay: number | null;
+                maxHoursPerWeek: number | null;
+            };
+        };
+        restaurantProfile: {
+            operatingHours: {
+                hours: {
+                    start: string;
+                    end: string;
+                }[];
+                dayOfWeek: number;
+                closed: boolean;
+            }[];
+        };
+    } | null>;
+    loading: import("vue").Ref<boolean, boolean>;
+    rosterLoading: import("vue").Ref<boolean, boolean>;
+    loadError: import("vue").Ref<string | null, string | null>;
+    scheduleSetupCompleted: import("vue").Ref<boolean, boolean>;
+    dataVersion: import("vue").Ref<number, number>;
+    outletId: import("vue").Ref<string, string>;
+    restaurantEmployees: import("vue").Ref<{
+        _id: string;
+        name: string;
+        code?: string | undefined;
+        passcode: string;
+        isMasterUser: boolean;
+        isRestricted: boolean;
+        restaurantRole: {
+            restaurantId: string;
+            roleId: string;
+        }[];
+    }[], IFdtoPosUserSummary[] | {
+        _id: string;
+        name: string;
+        code?: string | undefined;
+        passcode: string;
+        isMasterUser: boolean;
+        isRestricted: boolean;
+        restaurantRole: {
+            restaurantId: string;
+            roleId: string;
+        }[];
+    }[]>;
+    employeeConfigs: import("vue").Ref<{
+        employeeId: string;
+        enabled: boolean;
+        displayOrder: number | null;
+    }[], {
+        employeeId: string;
+        enabled: boolean;
+        displayOrder: number | null;
+    }[] | {
+        employeeId: string;
+        enabled: boolean;
+        displayOrder: number | null;
+    }[]>;
+    employeeOutletIds: import("vue").ShallowRef<Record<string, string[]>, Record<string, string[]>>;
+    businessEmployees: import("vue").ShallowRef<IFdtoPosUserSummary[], IFdtoPosUserSummary[]>;
+    positions: import("vue").Reactive<string[]>;
+    positionRecords: import("vue").Reactive<{
+        id: string;
+        name: string;
+    }[]>;
+    rolePositions: Record<string, string[]>;
+    outlet: {
+        name: string;
+    };
+    locationOptions: import("vue").Reactive<string[]>;
+    locationLabelById: Record<string, string>;
+    departmentOptions: import("vue").Reactive<string[]>;
+    compensationGroupOptions: import("vue").Reactive<string[]>;
+    compensationGroupMeta: Record<string, CompGroupMeta>;
+    existingStaff: import("vue").Reactive<ExistingStaffCandidate[]>;
+    shiftTemplates: import("vue").Reactive<ShiftTemplate[]>;
+    rules: {
+        coverage: Record<string, import("./types").CoverageRow>;
+        openFrom: string;
+        openTo: string;
+        dayHours: {
+            start: string;
+            end: string;
+        }[][];
+        payRate: {
+            NORMAL: {
+                overtime: number;
+            };
+            REST_DAY: {
+                regular: number;
+                overtime: number;
+            };
+            PUBLIC_HOLIDAY: {
+                regular: number;
+                overtime: number;
+            };
+        };
+        salesForecast: number;
+        closedWeekdays: number[];
+        labourTarget: number;
+        budgetFromSales: boolean;
+        budget: number;
+        otCapHours: number | null;
+        workingHours: {
+            minHoursPerDay: number | null;
+            maxHoursPerDay: number | null;
+            maxHoursPerWeek: number | null;
+        };
+        otBudget: number;
+        notify: {
+            waConnected: boolean;
+            waNumber: string;
+            waDisplayName: string;
+            defaults: {
+                wa: boolean;
+                push: boolean;
+                email: boolean;
+            };
+        };
+    };
+};
+export declare const payload: import("vue").ShallowRef<{
+    timeOff: {
+        type: "OFF_DAY" | "LEAVE";
+        status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED";
+        employeeId: string;
+        id: string;
+        leaveType: "UNPAID" | "ANNUAL" | "MEDICAL" | "EMERGENCY" | null;
+        startDate: string;
+        endDate: string;
+        startPart: "FULL_DAY" | "AM" | "PM";
+        endPart: "FULL_DAY" | "AM" | "PM";
+        reason: string;
+        attachmentIds: string[];
+        requestedBy: string;
+        requestedAt: string;
+        approvedBy: string | null;
+        approvedAt: string | null;
+        approvalComment: string | null;
+    }[];
+    outlet: {
+        id: string;
+        name: string;
+    };
+    range: {
+        from: string;
+        to: string;
+    };
+    days: {
+        date: string;
+        id: string;
+        updatedAt: string;
+        isPublicHoliday: boolean;
+        title: string;
+        description: string;
+        salesForecastOverride: number | null;
+    }[];
+    demands: {
+        date: string | null;
+        startTime: string;
+        endTime: string;
+        id: string;
+        dayOfWeek: number | null;
+        position: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        headcount: number;
+    }[];
+    assignments: {
+        status: "DRAFT" | "PUBLISHED" | "CONFIRMED";
+        date: string;
+        startTime: string;
+        endTime: string;
+        employeeId: string;
+        id: string;
+        position: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        breaks: ({
+            type: "DURATION";
+            minutes: number;
+            breakPayType: "PAID" | "UNPAID";
+        } | {
+            type: "TIME_RANGE";
+            breakPayType: "PAID" | "UNPAID";
+            startTime: string;
+            endTime: string;
+        })[];
+        updatedAt: string;
+    }[];
+    positions: {
+        id: string;
+        name: string;
+    }[];
+    employees: {
+        minHoursPerDay?: number | null | undefined;
+        overtime?: {
+            maxHoursPerMonth: number | null;
+        } | undefined;
+        workingHours?: {
+            minHoursPerDay: number | null;
+            maxHoursPerDay: number | null;
+            maxHoursPerWeek: number | null;
+        } | undefined;
+        employeeId: string;
+        name: string;
+        employmentType: "FULLTIME" | "PARTTIME";
+        wage: {
+            type: "HOURLY" | "MONTHLY";
+            amount: number;
+        };
+        primaryPosition: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        secondaryPositions: {
+            positionId: string;
+            positionName: string;
+        }[];
+        availability: {
+            dayOfWeek: number;
+            start: string;
+            end: string;
+        }[];
+    }[];
+    settings: {
+        settingsConfigured?: boolean | undefined;
+        overtime: {
+            maxHoursPerMonth: number | null;
+        };
+        payRate: {
+            NORMAL: {
+                overtime: number;
+            };
+            REST_DAY: {
+                overtime: number;
+                regular: number;
+            };
+            PUBLIC_HOLIDAY: {
+                overtime: number;
+                regular: number;
+            };
+        };
+        setupCompleted: boolean;
+        workingHours: {
+            minHoursPerDay: number | null;
+            maxHoursPerDay: number | null;
+            maxHoursPerWeek: number | null;
+        };
+    };
+    restaurantProfile: {
+        operatingHours: {
+            hours: {
+                start: string;
+                end: string;
+            }[];
+            dayOfWeek: number;
+            closed: boolean;
+        }[];
+    };
+} | null, {
+    timeOff: {
+        type: "OFF_DAY" | "LEAVE";
+        status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED";
+        employeeId: string;
+        id: string;
+        leaveType: "UNPAID" | "ANNUAL" | "MEDICAL" | "EMERGENCY" | null;
+        startDate: string;
+        endDate: string;
+        startPart: "FULL_DAY" | "AM" | "PM";
+        endPart: "FULL_DAY" | "AM" | "PM";
+        reason: string;
+        attachmentIds: string[];
+        requestedBy: string;
+        requestedAt: string;
+        approvedBy: string | null;
+        approvedAt: string | null;
+        approvalComment: string | null;
+    }[];
+    outlet: {
+        id: string;
+        name: string;
+    };
+    range: {
+        from: string;
+        to: string;
+    };
+    days: {
+        date: string;
+        id: string;
+        updatedAt: string;
+        isPublicHoliday: boolean;
+        title: string;
+        description: string;
+        salesForecastOverride: number | null;
+    }[];
+    demands: {
+        date: string | null;
+        startTime: string;
+        endTime: string;
+        id: string;
+        dayOfWeek: number | null;
+        position: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        headcount: number;
+    }[];
+    assignments: {
+        status: "DRAFT" | "PUBLISHED" | "CONFIRMED";
+        date: string;
+        startTime: string;
+        endTime: string;
+        employeeId: string;
+        id: string;
+        position: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        breaks: ({
+            type: "DURATION";
+            minutes: number;
+            breakPayType: "PAID" | "UNPAID";
+        } | {
+            type: "TIME_RANGE";
+            breakPayType: "PAID" | "UNPAID";
+            startTime: string;
+            endTime: string;
+        })[];
+        updatedAt: string;
+    }[];
+    positions: {
+        id: string;
+        name: string;
+    }[];
+    employees: {
+        minHoursPerDay?: number | null | undefined;
+        overtime?: {
+            maxHoursPerMonth: number | null;
+        } | undefined;
+        workingHours?: {
+            minHoursPerDay: number | null;
+            maxHoursPerDay: number | null;
+            maxHoursPerWeek: number | null;
+        } | undefined;
+        employeeId: string;
+        name: string;
+        employmentType: "FULLTIME" | "PARTTIME";
+        wage: {
+            type: "HOURLY" | "MONTHLY";
+            amount: number;
+        };
+        primaryPosition: {
+            positionId: string;
+            positionName: string;
+        } | null;
+        secondaryPositions: {
+            positionId: string;
+            positionName: string;
+        }[];
+        availability: {
+            dayOfWeek: number;
+            start: string;
+            end: string;
+        }[];
+    }[];
+    settings: {
+        settingsConfigured?: boolean | undefined;
+        overtime: {
+            maxHoursPerMonth: number | null;
+        };
+        payRate: {
+            NORMAL: {
+                overtime: number;
+            };
+            REST_DAY: {
+                overtime: number;
+                regular: number;
+            };
+            PUBLIC_HOLIDAY: {
+                overtime: number;
+                regular: number;
+            };
+        };
+        setupCompleted: boolean;
+        workingHours: {
+            minHoursPerDay: number | null;
+            maxHoursPerDay: number | null;
+            maxHoursPerWeek: number | null;
+        };
+    };
+    restaurantProfile: {
+        operatingHours: {
+            hours: {
+                start: string;
+                end: string;
+            }[];
+            dayOfWeek: number;
+            closed: boolean;
+        }[];
+    };
+} | null>, loading: import("vue").Ref<boolean, boolean>, rosterLoading: import("vue").Ref<boolean, boolean>, loadError: import("vue").Ref<string | null, string | null>, scheduleSetupCompleted: import("vue").Ref<boolean, boolean>, dataVersion: import("vue").Ref<number, number>, outletId: import("vue").Ref<string, string>, restaurantEmployees: import("vue").Ref<{
+    _id: string;
+    name: string;
+    code?: string | undefined;
+    passcode: string;
+    isMasterUser: boolean;
+    isRestricted: boolean;
+    restaurantRole: {
+        restaurantId: string;
+        roleId: string;
+    }[];
+}[], IFdtoPosUserSummary[] | {
+    _id: string;
+    name: string;
+    code?: string | undefined;
+    passcode: string;
+    isMasterUser: boolean;
+    isRestricted: boolean;
+    restaurantRole: {
+        restaurantId: string;
+        roleId: string;
+    }[];
+}[]>, employeeConfigs: import("vue").Ref<{
+    employeeId: string;
+    enabled: boolean;
+    displayOrder: number | null;
+}[], {
+    employeeId: string;
+    enabled: boolean;
+    displayOrder: number | null;
+}[] | {
+    employeeId: string;
+    enabled: boolean;
+    displayOrder: number | null;
+}[]>, employeeOutletIds: import("vue").ShallowRef<Record<string, string[]>, Record<string, string[]>>, businessEmployees: import("vue").ShallowRef<IFdtoPosUserSummary[], IFdtoPosUserSummary[]>, POSITIONS: import("vue").Reactive<string[]>, POSITION_RECORDS: import("vue").Reactive<{
+    id: string;
+    name: string;
+}[]>, ROLE_POSITIONS: Record<string, string[]>, OUTLET: {
+    name: string;
+}, LOCATION_OPTIONS: import("vue").Reactive<string[]>, LOCATION_LABEL_BY_ID: Record<string, string>, DEPT_OPTIONS: import("vue").Reactive<string[]>, COMPGRP_OPTIONS: import("vue").Reactive<string[]>, COMPGRP_META: Record<string, CompGroupMeta>, EXISTING_STAFF: import("vue").Reactive<ExistingStaffCandidate[]>, SHIFT_TEMPLATES: import("vue").Reactive<ShiftTemplate[]>, RULES: {
+    coverage: Record<string, import("./types").CoverageRow>;
+    openFrom: string;
+    openTo: string;
+    dayHours: {
+        start: string;
+        end: string;
+    }[][];
+    payRate: {
+        NORMAL: {
+            overtime: number;
+        };
+        REST_DAY: {
+            regular: number;
+            overtime: number;
+        };
+        PUBLIC_HOLIDAY: {
+            regular: number;
+            overtime: number;
+        };
+    };
+    salesForecast: number;
+    closedWeekdays: number[];
+    labourTarget: number;
+    budgetFromSales: boolean;
+    budget: number;
+    otCapHours: number | null;
+    workingHours: {
+        minHoursPerDay: number | null;
+        maxHoursPerDay: number | null;
+        maxHoursPerWeek: number | null;
+    };
+    otBudget: number;
+    notify: {
+        waConnected: boolean;
+        waNumber: string;
+        waDisplayName: string;
+        defaults: {
+            wa: boolean;
+            push: boolean;
+            email: boolean;
+        };
+    };
+};
+/** Restore all outlet-scoped rules before another outlet is allowed to populate them. Keeping
+ * the reactive object and its nested containers alive matters because many board composables
+ * hold references to RULES members rather than reading the store object afresh. */
+export declare function resetRules(): void;