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

package/dist/src/views/scheduling/locales/index.d.ts

@@ -0,0 +1,496 @@
+import * as enUS from './en-US.json';
+export type AppMessagesSchema = typeof enUS;
+export declare const i18nMessages: {
+    'en-US': {
+        scheduling: {
+            nav: {
+                section: string;
+                board: string;
+                position: string;
+                general: string;
+            };
+            topbar: {
+                today: string;
+                copy: string;
+                autoSchedule: string;
+                actions: string;
+                exportSchedule: string;
+                clearAllShifts: string;
+                comingSoon: string;
+            };
+            status: {
+                draft: string;
+                published: string;
+            };
+            staffRail: {
+                title: string;
+                dragHint: string;
+                searchPlaceholder: string;
+                sortLoad: string;
+                sortName: string;
+                sortHours: string;
+                sortCost: string;
+                addEmployee: string;
+                openShifts: string;
+                allCovered: string;
+                openRemaining: string;
+                noPositionsAdded: string;
+                noPositionTitle: string;
+            };
+            grid: {
+                employeeColumn: string;
+                scrollEarlier: string;
+                scrollLater: string;
+            };
+            costRail: {
+                title: string;
+                weekly: string;
+                monthlyOt: string;
+                used: string;
+            };
+            shiftEditor: {
+                title: string;
+                newTitle: string;
+                start: string;
+                end: string;
+                role: string;
+                headcount: string;
+                repeat: string;
+                splitShift: string;
+                addSplit: string;
+                delete: string;
+                save: string;
+                cancel: string;
+            };
+            assign: {
+                title: string;
+                searchPlaceholder: string;
+                noMatches: string;
+                assign: string;
+            };
+            leave: {
+                title: string;
+                approve: string;
+                reject: string;
+                remove: string;
+                appliedOn: string;
+                balance: string;
+            };
+            clash: {
+                title: string;
+                proceed: string;
+                cancel: string;
+            };
+            clearShifts: {
+                title: string;
+                body: string;
+                confirm: string;
+                cancel: string;
+            };
+            addEmployee: {
+                title: string;
+                stepDetails: string;
+                stepAvailability: string;
+                name: string;
+                role: string;
+                location: string;
+                department: string;
+                compGroup: string;
+                employment: string;
+                fullTime: string;
+                partTime: string;
+                weeklyAvailability: string;
+                timeOffDays: string;
+                selectExisting: string;
+                back: string;
+                next: string;
+                create: string;
+            };
+            selectExisting: {
+                title: string;
+                subtitle: string;
+            };
+            employeeProfile: {
+                weekHours: string;
+                remarks: string;
+                positions: string;
+                rate: string;
+            };
+            dateRange: {
+                today: string;
+                thisWeek: string;
+                nextWeek: string;
+            };
+            comingSoon: string;
+        };
+    };
+    'zh-CN': {
+        scheduling: {
+            nav: {
+                section: string;
+                board: string;
+                position: string;
+                general: string;
+            };
+            topbar: {
+                today: string;
+                copy: string;
+                autoSchedule: string;
+                actions: string;
+                exportSchedule: string;
+                clearAllShifts: string;
+                comingSoon: string;
+            };
+            status: {
+                draft: string;
+                published: string;
+            };
+            staffRail: {
+                title: string;
+                dragHint: string;
+                searchPlaceholder: string;
+                sortLoad: string;
+                sortName: string;
+                sortHours: string;
+                sortCost: string;
+                addEmployee: string;
+                openShifts: string;
+                allCovered: string;
+                openRemaining: string;
+                noPositionsAdded: string;
+                noPositionTitle: string;
+            };
+            grid: {
+                employeeColumn: string;
+                scrollEarlier: string;
+                scrollLater: string;
+            };
+            costRail: {
+                title: string;
+                weekly: string;
+                monthlyOt: string;
+                used: string;
+            };
+            shiftEditor: {
+                title: string;
+                newTitle: string;
+                start: string;
+                end: string;
+                role: string;
+                headcount: string;
+                repeat: string;
+                splitShift: string;
+                addSplit: string;
+                delete: string;
+                save: string;
+                cancel: string;
+            };
+            assign: {
+                title: string;
+                searchPlaceholder: string;
+                noMatches: string;
+                assign: string;
+            };
+            leave: {
+                title: string;
+                approve: string;
+                reject: string;
+                remove: string;
+                appliedOn: string;
+                balance: string;
+            };
+            clash: {
+                title: string;
+                proceed: string;
+                cancel: string;
+            };
+            clearShifts: {
+                title: string;
+                body: string;
+                confirm: string;
+                cancel: string;
+            };
+            addEmployee: {
+                title: string;
+                stepDetails: string;
+                stepAvailability: string;
+                name: string;
+                role: string;
+                location: string;
+                department: string;
+                compGroup: string;
+                employment: string;
+                fullTime: string;
+                partTime: string;
+                weeklyAvailability: string;
+                timeOffDays: string;
+                selectExisting: string;
+                back: string;
+                next: string;
+                create: string;
+            };
+            selectExisting: {
+                title: string;
+                subtitle: string;
+            };
+            employeeProfile: {
+                weekHours: string;
+                remarks: string;
+                positions: string;
+                rate: string;
+            };
+            dateRange: {
+                today: string;
+                thisWeek: string;
+                nextWeek: string;
+            };
+            comingSoon: string;
+        };
+    };
+    'th-TH': {
+        scheduling: {
+            nav: {
+                section: string;
+                board: string;
+                position: string;
+                general: string;
+            };
+            topbar: {
+                today: string;
+                copy: string;
+                autoSchedule: string;
+                actions: string;
+                exportSchedule: string;
+                clearAllShifts: string;
+                comingSoon: string;
+            };
+            status: {
+                draft: string;
+                published: string;
+            };
+            staffRail: {
+                title: string;
+                dragHint: string;
+                searchPlaceholder: string;
+                sortLoad: string;
+                sortName: string;
+                sortHours: string;
+                sortCost: string;
+                addEmployee: string;
+                openShifts: string;
+                allCovered: string;
+                openRemaining: string;
+                noPositionsAdded: string;
+                noPositionTitle: string;
+            };
+            grid: {
+                employeeColumn: string;
+                scrollEarlier: string;
+                scrollLater: string;
+            };
+            costRail: {
+                title: string;
+                weekly: string;
+                monthlyOt: string;
+                used: string;
+            };
+            shiftEditor: {
+                title: string;
+                newTitle: string;
+                start: string;
+                end: string;
+                role: string;
+                headcount: string;
+                repeat: string;
+                splitShift: string;
+                addSplit: string;
+                delete: string;
+                save: string;
+                cancel: string;
+            };
+            assign: {
+                title: string;
+                searchPlaceholder: string;
+                noMatches: string;
+                assign: string;
+            };
+            leave: {
+                title: string;
+                approve: string;
+                reject: string;
+                remove: string;
+                appliedOn: string;
+                balance: string;
+            };
+            clash: {
+                title: string;
+                proceed: string;
+                cancel: string;
+            };
+            clearShifts: {
+                title: string;
+                body: string;
+                confirm: string;
+                cancel: string;
+            };
+            addEmployee: {
+                title: string;
+                stepDetails: string;
+                stepAvailability: string;
+                name: string;
+                role: string;
+                location: string;
+                department: string;
+                compGroup: string;
+                employment: string;
+                fullTime: string;
+                partTime: string;
+                weeklyAvailability: string;
+                timeOffDays: string;
+                selectExisting: string;
+                back: string;
+                next: string;
+                create: string;
+            };
+            selectExisting: {
+                title: string;
+                subtitle: string;
+            };
+            employeeProfile: {
+                weekHours: string;
+                remarks: string;
+                positions: string;
+                rate: string;
+            };
+            dateRange: {
+                today: string;
+                thisWeek: string;
+                nextWeek: string;
+            };
+            comingSoon: string;
+        };
+    };
+    'zh-Hant': {
+        scheduling: {
+            nav: {
+                section: string;
+                board: string;
+                position: string;
+                general: string;
+            };
+            topbar: {
+                today: string;
+                copy: string;
+                autoSchedule: string;
+                actions: string;
+                exportSchedule: string;
+                clearAllShifts: string;
+                comingSoon: string;
+            };
+            status: {
+                draft: string;
+                published: string;
+            };
+            staffRail: {
+                title: string;
+                dragHint: string;
+                searchPlaceholder: string;
+                sortLoad: string;
+                sortName: string;
+                sortHours: string;
+                sortCost: string;
+                addEmployee: string;
+                openShifts: string;
+                allCovered: string;
+                openRemaining: string;
+                noPositionsAdded: string;
+                noPositionTitle: string;
+            };
+            grid: {
+                employeeColumn: string;
+                scrollEarlier: string;
+                scrollLater: string;
+            };
+            costRail: {
+                title: string;
+                weekly: string;
+                monthlyOt: string;
+                used: string;
+            };
+            shiftEditor: {
+                title: string;
+                newTitle: string;
+                start: string;
+                end: string;
+                role: string;
+                headcount: string;
+                repeat: string;
+                splitShift: string;
+                addSplit: string;
+                delete: string;
+                save: string;
+                cancel: string;
+            };
+            assign: {
+                title: string;
+                searchPlaceholder: string;
+                noMatches: string;
+                assign: string;
+            };
+            leave: {
+                title: string;
+                approve: string;
+                reject: string;
+                remove: string;
+                appliedOn: string;
+                balance: string;
+            };
+            clash: {
+                title: string;
+                proceed: string;
+                cancel: string;
+            };
+            clearShifts: {
+                title: string;
+                body: string;
+                confirm: string;
+                cancel: string;
+            };
+            addEmployee: {
+                title: string;
+                stepDetails: string;
+                stepAvailability: string;
+                name: string;
+                role: string;
+                location: string;
+                department: string;
+                compGroup: string;
+                employment: string;
+                fullTime: string;
+                partTime: string;
+                weeklyAvailability: string;
+                timeOffDays: string;
+                selectExisting: string;
+                back: string;
+                next: string;
+                create: string;
+            };
+            selectExisting: {
+                title: string;
+                subtitle: string;
+            };
+            employeeProfile: {
+                weekHours: string;
+                remarks: string;
+                positions: string;
+                rate: string;
+            };
+            dateRange: {
+                today: string;
+                thisWeek: string;
+                nextWeek: string;
+            };
+            comingSoon: string;
+        };
+    };
+};

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

@@ -0,0 +1,151 @@
+import type { IFdtoPosUserSummary } from '@/types/employee';
+import type { FdtoScheduleAssignment, FdtoScheduleAutoScheduleReq, FdtoScheduleAutoScheduleResult, FdtoScheduleBoard, FdtoScheduleBulkUpdateAssignmentStatusReq, FdtoScheduleCreateEmployeeProfileReq, FdtoScheduleSaveAssignmentReq, FdtoScheduleSavePositionReq, FdtoScheduleSaveScheduleDayReq, FdtoScheduleUpdateEmployeeProfileReq, ScheduleReplaceDemandReq } from '@/types/schedule';
+/** dayjs-free local-date key — the board's own isoDateKey, repeated here so the store does not
+ * have to import a composable. Local Y/M/D, never UTC: a BSON-free 'YYYY-MM-DD' that survives
+ * a timezone west of Greenwich. */
+export declare function isoDate(d: Date): string;
+export declare const payload: import("vue").ShallowRef<FdtoScheduleBoard | null, FdtoScheduleBoard | null>;
+export declare const loading: import("vue").Ref<boolean, boolean>;
+/** The POS roster (who the board's rows are) is fetched separately from the board window. */
+export declare const rosterLoading: import("vue").Ref<boolean, boolean>;
+export declare const loadError: import("vue").Ref<string | null, string | null>;
+/** Whether this outlet has finished setting up scheduling (onboarding). The schedule settings
+ * will carry this, but the backend has no such field yet, so it is a plain flag that defaults to
+ * "not finished" — the setup banner keys off it. TODO: when the field exists, set it from the
+ * settings payload where `payload` is applied (and flip it when the onboarding wizard finishes);
+ * nothing else needs to change. */
+export declare const scheduleSetupCompleted: import("vue").Ref<boolean, boolean>;
+/** Bumped every time `payload` is replaced. Anything that caches a derived view of the data
+ * — the board's per-week buckets above all — watches this and rebuilds. */
+export declare const dataVersion: import("vue").Ref<number, number>;
+/** The outlet the board is reading. A ref rather than a plain variable so the picker's label
+ * follows a switch immediately, without waiting for the new outlet's payload to land. */
+export declare const outletId: import("vue").Ref<string, string>;
+/** Who actually works this outlet, per the POS roster (`restaurantRole` on the pos-user
+ * record) — the board's roster is everyone here, not everyone with a Schedule EmployeeProfile.
+ * A profile stays business-wide scheduling settings for a person (pay/positions/availability);
+ * it no longer decides who shows up at all, only what shows once they do. */
+export declare const 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;
+    }[];
+}[]>;
+/** Points the board at an outlet. Switching throws the held window away rather than widening
+ * it — two outlets' rosters are not one dataset, and half of each is not a schedule.
+ *
+ * Returns whether anything changed, so a caller that has to follow up with a fetch can skip
+ * the round trip when the picker was set to what was already showing. */
+export declare function setOutlet(restaurantId: string): boolean;
+/** Fetches (once per outlet) who the POS roster says works here, straight off the same
+ * `restaurantIds`-filterable endpoint the portal's own Employee List uses — no Schedule-side
+ * concept of outlet membership to keep in sync with it. Bumps `dataVersion` on arrival so the
+ * board's per-week employee cache (keyed off it already) picks the roster up without a second,
+ * separate invalidation path. A generous page size rather than looping pages: real restaurant
+ * headcounts sit nowhere near it. */
+export declare function ensureRestaurantEmployeesLoaded(restaurantId: string): Promise<void>;
+/** Re-reads this outlet's POS roster. The roster is what the board's rows are built from and is
+ * otherwise fetched once per outlet, so any write that changes who works here (add, remove)
+ * has to call this for the grid to show it. */
+export declare function refreshRestaurantEmployees(): Promise<void>;
+/** Gives an existing POS user a role at this outlet, so they land on its roster. */
+export declare function addEmployeeToOutlet(employeeId: string, roleId: string): Promise<void>;
+/** Takes a POS user off the given outlets' rosters; their other outlets are untouched. */
+export declare function removeEmployeeFromOutlets(employeeId: string, restaurantIds: string[]): Promise<void>;
+/** Takes a POS user off this outlet's roster only. */
+export declare function removeEmployeeFromOutlet(employeeId: string): Promise<void>;
+/** Every outlet each person works at (POS user id → outlet ids). The roster above is fetched
+ * FILTERED to one outlet, and a filtered read describes a person by that outlet alone, so the
+ * full list has to come from an unfiltered read. Paged until the total is covered. A failure
+ * leaves the map empty rather than failing the board: locations are display-only here. */
+export declare const employeeOutletIds: import("vue").ShallowRef<Record<string, string[]>, Record<string, string[]>>;
+/** Everyone in the business (POS user summaries: name, passcode, outlet roles), kept once and
+ * shared by the locations map, "select existing employee", passcode prefill and the role edits —
+ * the plain `/pos-users` read they used before returns every user-outlet row in one slow call. */
+export declare const businessEmployees: import("vue").ShallowRef<IFdtoPosUserSummary[], IFdtoPosUserSummary[]>;
+/** The cached business roster, fetched on first use. `force` re-reads it (after a write, or to
+ * refresh a list that is already on screen). Concurrent callers share one request. */
+export declare function ensureBusinessEmployees(force?: boolean): Promise<IFdtoPosUserSummary[]>;
+/** Guarantees the week starting `weekStart` is in memory, fetching a padded window around it
+ * if it is not. Safe to call on every navigation: a week already covered costs nothing. */
+export declare function ensureWeekLoaded(weekStart: Date): Promise<void>;
+/** Re-reads the currently held window from the API — what a write path calls once it has
+ * saved, and what the page offers after a failure. */
+export declare function reload(): Promise<void>;
+/** Puts an existing employee onto the current outlet's schedule. Pushes the record the API
+ * hands back straight onto the held payload instead of reloading — a reload re-derives every
+ * employee's shifts from what's actually stored, and shifts have no write path of their own
+ * yet, so it would silently discard any shift assigned to anyone else on the board earlier in
+ * the same sitting (the same bug shape saveDemand's callers used to have). data.ts's
+ * `employeeNumberOf` assigns the new hire a board id the next time it runs, same as it does for
+ * everyone loaded from the initial read, so nothing here needs to know that mapping itself.
+ * Throws on failure (a duplicate profile, a network error) — the caller decides how to show
+ * that, this just doesn't pretend it succeeded. */
+export declare function createEmployeeProfile(req: FdtoScheduleCreateEmployeeProfileReq): Promise<void>;
+/** Edits a profile already on this outlet's schedule. The caller (useScheduleAddEmployee's
+ * `updateExisting`) applies the form to the live `Employee` object itself for instant feedback,
+ * so this does not bump `dataVersion` — nothing needs a re-derive right now. It still patches
+ * the entry inside `payload.value.employees` in place, though: that raw array is what the NEXT
+ * re-derive (the next employee added, the next outlet reload) rebuilds every `Employee` from,
+ * and a stale entry there would silently revert this edit the moment something else triggers
+ * one, exactly the trap `createEmployeeProfile` above avoids by pushing onto the same array. */
+export declare function updateEmployeeProfile(employeeId: string, req: FdtoScheduleUpdateEmployeeProfileReq): Promise<void>;
+/** Positions are business-level, not per-outlet (see `ScheduleAPI.createPosition`'s own note)
+ * — so unlike the shift-shaped writes below, there's no "discards an unsaved shift" risk in
+ * refreshing the catalogue here: `payload` is reassigned as a NEW top-level object (same
+ * `employees`/`assignments`/etc. array references, only `positions` itself replaced) so
+ * data.ts's `watch(payload, applyCatalogues)` re-derives `POSITIONS`/`POSITION_RECORDS` —
+ * without touching `dataVersion`, which would otherwise invalidate the board's per-week
+ * employee cache and risk reverting a shift committed earlier in the same sitting that hasn't
+ * round-tripped into `payload.value.assignments` yet (see createAssignment's own note below). */
+export declare function createPosition(req: FdtoScheduleSavePositionReq): Promise<void>;
+export declare function updatePosition(id: string, req: FdtoScheduleSavePositionReq): Promise<void>;
+export declare function deletePosition(id: string): Promise<void>;
+/** Replaces one date's note/holiday-mark. Same shallow `payload` reassignment as the position
+ * writes above and for the same reason: `useScheduleBoard.ts` seeds its `dayNotes`/
+ * `manualHolidays` state from `payload.value.days` on every `payload` reassignment, so this has
+ * to land there for that seed to stay correct — without a `dataVersion` bump, which would
+ * invalidate the per-week employee cache and risk reverting an unsaved shift. */
+export declare function saveScheduleDay(date: string, req: FdtoScheduleSaveScheduleDayReq): Promise<void>;
+/** Replaces one date/weekday's UI demand by expanding every period into flat ShiftDemand rows.
+ * Position-specific headcount becomes its own row; any remaining headcount becomes an
+ * unpositioned row for the same time range. */
+export declare function saveDemand(req: ScheduleReplaceDemandReq): Promise<void>;
+/** Copies one date's own demand rows onto another date, as that date's own rows. A date that
+ * already has demand of its own is left alone (nothing is overwritten), and a source date with
+ * none has nothing to copy: the standing weekday rule already covers the same weekday in every
+ * week, so repeating it per date would only shadow later edits to the rule. Returns how many rows
+ * were written. */
+export declare function copyDateDemand(fromDate: string, toDate: string): Promise<number>;
+export declare function generateAutoSchedule(req: FdtoScheduleAutoScheduleReq): Promise<FdtoScheduleAutoScheduleResult>;
+/** A one-off shift assignment — someone working these hours on this date, not answering any
+ * Shift requirement. Deliberately does not reload: unlike `createEmployeeProfile` above, there
+ * is nothing here a reload could bring back that the caller doesn't already have — `commitShift`
+ * writes `assignmentId` onto the slot itself once this resolves, and a reload would only risk
+ * discarding some OTHER unsaved shift elsewhere on the board (shifts have no write path of
+ * their own to read back from yet). */
+export declare function createAssignment(req: FdtoScheduleSaveAssignmentReq): Promise<FdtoScheduleAssignment>;
+export declare function updateAssignment(id: string, req: FdtoScheduleSaveAssignmentReq): Promise<FdtoScheduleAssignment | null>;
+/** Deletes a batch of existing assignments in a single request — see
+ * `ScheduleAPI.deleteAssignments`. Deleting one is just this with a single-id array. */
+export declare function deleteAssignments(ids: string[]): Promise<void>;
+/** Flips a batch of existing assignments to one status in a single request — see
+ * `ScheduleAPI.bulkUpdateAssignmentStatus`. */
+export declare function bulkUpdateAssignmentStatus(req: FdtoScheduleBulkUpdateAssignmentStatusReq): Promise<FdtoScheduleAssignment[]>;