@easyteam/auto-scheduler-modal-ui 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,432 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ThemeOverride } from '@chakra-ui/react';
+
+declare class RequestError extends Error {
+    status: number;
+    payload?: unknown;
+    constructor(message: string, status: number, payload?: unknown);
+}
+type ScheduleSolutionEmployee = {
+    id: string;
+    name?: string;
+    position?: string;
+    properties?: Record<string, unknown>;
+    locationIds?: string[];
+};
+type ScheduleSolutionLocation = {
+    id: string;
+    timezone?: string;
+    jurisdiction?: string;
+    tags?: string[];
+    properties?: Record<string, unknown>;
+};
+type ScheduleSolutionShift = {
+    id: string;
+    startDateTime?: string;
+    endDateTime?: string;
+    startTime?: string;
+    endTime?: string;
+    requiredHours?: number;
+    requiredPosition?: string | null;
+    requiredCount?: number;
+    location?: ScheduleSolutionLocation;
+    employeePreferences?: Array<{
+        employeeId: string;
+        level: string;
+    }>;
+};
+type ShiftAssignmentJustification = {
+    status: string;
+    constraintName?: string;
+    ruleId?: string | null;
+    archetype?: string | null;
+    jurisdiction?: string | null;
+    type: string;
+    impact?: string;
+    description?: string;
+};
+type ScheduleSolutionShiftAssignment = {
+    id: number;
+    shift?: ScheduleSolutionShift;
+    slotIndex?: number;
+    employee?: ScheduleSolutionEmployee | null;
+    pinned: boolean;
+    justifications?: ShiftAssignmentJustification[];
+};
+type ScheduleSolutionAvailability = {
+    employeeId: string;
+    type?: string;
+    daysOfWeek?: string[];
+    specificDates?: string[];
+    startTime?: string;
+    endTime?: string;
+};
+type ScheduleSolutionTimeOff = {
+    employeeId: string;
+    startDateTime: string;
+    endDateTime: string;
+};
+type ScheduleSolutionWaiver = {
+    employeeId: string;
+    ruleId: string;
+    expiry?: string;
+};
+type ScheduleSolutionRuleMetadata = Record<string, unknown>;
+type ScheduleSolutionRuleOverride = {
+    ruleId: string;
+    parameters?: Record<string, unknown>;
+};
+type ScheduleSolution = {
+    employees?: ScheduleSolutionEmployee[];
+    shifts?: ScheduleSolutionShift[];
+    shiftAssignments?: ScheduleSolutionShiftAssignment[];
+    locations?: ScheduleSolutionLocation[];
+    availabilities?: ScheduleSolutionAvailability[];
+    timeOffs?: ScheduleSolutionTimeOff[];
+    waivers?: ScheduleSolutionWaiver[];
+    ruleMetadata?: ScheduleSolutionRuleMetadata[];
+    ruleOverrides?: ScheduleSolutionRuleOverride[];
+    ruleIds?: string[] | null;
+    demandCurve?: unknown | null;
+    mode?: "FIXED_TEMPLATE" | "FLEXIBLE_DEMAND" | "MIXED";
+    score?: string;
+};
+
+type LocationOption = {
+    id: string;
+    name: string;
+    timezone: string;
+    jurisdiction: string;
+    properties?: Record<string, unknown>;
+};
+type JurisdictionGroup = {
+    id: string;
+    title: string;
+    locations: LocationOption[];
+};
+type TimeOff = {
+    employeeId: string;
+    startDateTime: string;
+    endDateTime: string;
+};
+type OpenShift = {
+    id: string;
+    startTime: string;
+    endTime: string;
+    location: {
+        id: string;
+    };
+    requiredPosition: string;
+    requiredCount: number;
+    employeePreferences: Array<{
+        employeeId: string;
+        level: "PREFERRED" | "AVAILABLE" | "UNAVAILABLE" | string;
+    }>;
+    employeeId?: string;
+};
+type EmployeeProperties = {
+    employer_type: string;
+    worker_type: string;
+    costToRevenueRatio?: number;
+    avgSalesAmount?: number;
+    [key: string]: object | string | number | boolean | undefined;
+};
+type Employee = {
+    id: string;
+    name: string;
+    position: string;
+    locationIds: Array<string>;
+    properties: EmployeeProperties;
+};
+type EasyTeamThemeOverrides = {
+    tokens?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+type AutoSchedulerModalStyleOverrides = {
+    overlay?: Record<string, unknown>;
+    content?: Record<string, unknown>;
+    header?: Record<string, unknown>;
+    title?: Record<string, unknown>;
+    closeButton?: Record<string, unknown>;
+    body?: Record<string, unknown>;
+    banner?: Record<string, unknown>;
+    bannerIcon?: Record<string, unknown>;
+    bannerTitle?: Record<string, unknown>;
+    bannerText?: Record<string, unknown>;
+    locationSection?: Record<string, unknown>;
+    locationLabelRow?: Record<string, unknown>;
+    locationLabel?: Record<string, unknown>;
+    locationBadge?: Record<string, unknown>;
+    locationSubtitle?: Record<string, unknown>;
+    locationTrigger?: Record<string, unknown>;
+    locationTriggerText?: Record<string, unknown>;
+    popoverContent?: Record<string, unknown>;
+    groupHeader?: Record<string, unknown>;
+    optionRow?: Record<string, unknown>;
+    optionLabel?: Record<string, unknown>;
+    selectedBanner?: Record<string, unknown>;
+    selectedBannerIcon?: Record<string, unknown>;
+    selectedBannerText?: Record<string, unknown>;
+    hardConstraintsSection?: Record<string, unknown>;
+    hardConstraintsLabelRow?: Record<string, unknown>;
+    hardConstraintsLabel?: Record<string, unknown>;
+    hardConstraintsBadge?: Record<string, unknown>;
+    hardConstraintsSubtitle?: Record<string, unknown>;
+    hardConstraintsTrigger?: Record<string, unknown>;
+    hardConstraintsTriggerText?: Record<string, unknown>;
+    hardConstraintsPopoverContent?: Record<string, unknown>;
+    hardConstraintsOptionRow?: Record<string, unknown>;
+    hardConstraintsOptionLabel?: Record<string, unknown>;
+    hardConstraintsInputsContainer?: Record<string, unknown>;
+    hardConstraintsInputItem?: Record<string, unknown>;
+    hardConstraintsInputLabel?: Record<string, unknown>;
+    hardConstraintsInputField?: Record<string, unknown>;
+    optimizationSection?: Record<string, unknown>;
+    optimizationLabelRow?: Record<string, unknown>;
+    optimizationLabel?: Record<string, unknown>;
+    optimizationBadge?: Record<string, unknown>;
+    optimizationSubtitle?: Record<string, unknown>;
+    optimizationTrigger?: Record<string, unknown>;
+    optimizationTriggerText?: Record<string, unknown>;
+    optimizationPopoverContent?: Record<string, unknown>;
+    optimizationGroupHeader?: Record<string, unknown>;
+    optimizationOptionRow?: Record<string, unknown>;
+    optimizationOptionLabel?: Record<string, unknown>;
+    optimizationOptionHelp?: Record<string, unknown>;
+    optimizationInputsContainer?: Record<string, unknown>;
+    optimizationInputItem?: Record<string, unknown>;
+    optimizationInputLabel?: Record<string, unknown>;
+    optimizationInputField?: Record<string, unknown>;
+    optimizationSuffix?: Record<string, unknown>;
+    optimizationDivider?: Record<string, unknown>;
+    optimizationSummary?: Record<string, unknown>;
+    creatingBody?: Record<string, unknown>;
+    stepsContainer?: Record<string, unknown>;
+    stepsList?: Record<string, unknown>;
+    stepRow?: Record<string, unknown>;
+    stepIcon?: Record<string, unknown>;
+    stepIconActive?: Record<string, unknown>;
+    stepIconDone?: Record<string, unknown>;
+    stepIconPending?: Record<string, unknown>;
+    stepIconFailed?: Record<string, unknown>;
+    stepTitle?: Record<string, unknown>;
+    stepTitleActive?: Record<string, unknown>;
+    stepTitleDone?: Record<string, unknown>;
+    stepTitlePending?: Record<string, unknown>;
+    stepTitleFailed?: Record<string, unknown>;
+    stepSubtitle?: Record<string, unknown>;
+    violationPanel?: Record<string, unknown>;
+    violationHeaderRow?: Record<string, unknown>;
+    violationHeader?: Record<string, unknown>;
+    violationIcon?: Record<string, unknown>;
+    violationTitle?: Record<string, unknown>;
+    violationSubtitle?: Record<string, unknown>;
+    violationToggleButton?: Record<string, unknown>;
+    violationToggleIcon?: Record<string, unknown>;
+    violationContent?: Record<string, unknown>;
+    violationItem?: Record<string, unknown>;
+    violationItemTitle?: Record<string, unknown>;
+    violationItemDetailRow?: Record<string, unknown>;
+    violationItemDetail?: Record<string, unknown>;
+    violationBullet?: Record<string, unknown>;
+    recommendationsBox?: Record<string, unknown>;
+    recommendationsTitle?: Record<string, unknown>;
+    recommendationsList?: Record<string, unknown>;
+    recommendationsItem?: Record<string, unknown>;
+    recommendationsBullet?: Record<string, unknown>;
+    recommendationsToggle?: Record<string, unknown>;
+    failedFooter?: Record<string, unknown>;
+    failedPrimaryButton?: Record<string, unknown>;
+    failedSecondaryButton?: Record<string, unknown>;
+    footer?: Record<string, unknown>;
+    cancelButton?: Record<string, unknown>;
+    primaryButton?: Record<string, unknown>;
+    violatedConstraintsSecondaryButton?: Record<string, unknown>;
+};
+type AutoSchedulerModalTheme = (ThemeOverride & {
+    autoSchedulerModal?: AutoSchedulerModalStyleOverrides;
+}) | (EasyTeamThemeOverrides & {
+    autoSchedulerModal?: AutoSchedulerModalStyleOverrides;
+});
+type AutoSchedulerModalProps = {
+    baseURL: string;
+    isOpen: boolean;
+    title?: string;
+    bannerText?: string;
+    jurisdictions: JurisdictionGroup[];
+    employees: Employee[];
+    openShifts: OpenShift[];
+    timeOffs?: TimeOff[];
+    locationPlaceholder?: string;
+    onClose: () => void;
+    cancelLabel?: string;
+    primaryActionLabel?: string;
+    onPrimaryAction?: () => void;
+    onFixManually?: (failure: ViolatedConstraintsResult, config: AutoSchedulerModalConfig) => void;
+    initialConfig?: AutoSchedulerModalConfig & {
+        failure?: ViolatedConstraintsResult;
+    };
+    theme?: AutoSchedulerModalTheme;
+    cssVarsRoot?: string;
+    generateRecommendationsURLAndHeaders: {
+        url: string;
+        headers?: Record<string, string>;
+    };
+    onSolution: (solution: ScheduleSolution) => Promise<void>;
+};
+type Screen = "configure" | "creating" | "failed";
+type StepStatus = "pending" | "active" | "done";
+type RuleOverrideEntry = {
+    ruleId: string;
+    parameters?: Record<string, unknown>;
+    weightPoints?: number;
+};
+type SchedulePayload = {
+    employees: Array<{
+        id: string;
+        name?: string;
+        position?: string;
+        locationIds?: string[];
+        properties?: Record<string, unknown>;
+    }>;
+    shifts: Array<{
+        id: string;
+        startDateTime: string;
+        endDateTime: string;
+        employeeId?: string;
+        requiredHours?: number;
+        requiredPosition?: string | null;
+        requiredCount?: number;
+        location?: {
+            id: string;
+            timezone?: string;
+            tags?: string[];
+        };
+        employeePreferences?: Array<{
+            employeeId: string;
+            level: string;
+        }>;
+    }>;
+    locations: Array<{
+        id: string;
+        timezone?: string;
+        jurisdiction?: string;
+        tags?: string[];
+    }>;
+    timeOffs?: TimeOff[];
+    ruleIds?: string[];
+    ruleOverrides?: RuleOverrideEntry[];
+};
+type AutoSchedulerModalConfig = {
+    selectedLocationIds: string[];
+    selectedConstraintIds: string[];
+    constraintValues: Record<string, string>;
+    selectedOptimizationIds: string[];
+    optimizationValues: Record<string, string>;
+};
+type SolveApiExplanation = SolveApiResponse["explanation"];
+/** Full POST body for the getRecommendationURL API (context, locations, employees, shifts, etc.) */
+type RecommendationPayload = {
+    context: {
+        selectedLocationIds: string[];
+        selectedConstraintIds: string[];
+        constraintValues: Record<string, string>;
+        selectedOptimizationIds: string[];
+        optimizationValues: Record<string, string>;
+        timezone?: string;
+    };
+    locations: LocationOption[];
+    employees: Employee[];
+    openShifts: OpenShift[];
+    assignedShifts: OpenShift[];
+    timeOffs: TimeOff[];
+    explanation: SolveApiExplanation;
+};
+type ViolatedConstraintsResult = {
+    violatedConstraints: Array<{
+        title: string;
+        detail: string;
+    }>;
+    recommendedFixes: string[];
+    /** Full context for fetching recommendations; built once in the modal and passed through */
+    recommendationPayload?: RecommendationPayload;
+};
+type ViolatedConstraintsPanelStyleOverrides = Pick<AutoSchedulerModalStyleOverrides, "violationPanel" | "violationHeaderRow" | "violationHeader" | "violationIcon" | "violationTitle" | "violationSubtitle" | "violationToggleButton" | "violationToggleIcon" | "violationContent" | "violationItem" | "violationItemTitle" | "violationItemDetailRow" | "violationItemDetail" | "violationBullet" | "recommendationsBox" | "recommendationsTitle" | "recommendationsList" | "recommendationsItem" | "recommendationsBullet" | "recommendationsToggle" | "failedSecondaryButton">;
+type ViolatedConstraintsPanelProps = {
+    violatedConstraints: ViolatedConstraintsResult;
+    title?: string;
+    subtitle?: string;
+    showSecondaryButton?: boolean;
+    secondaryButtonTitle?: string;
+    onSecondaryButtonClick?: () => void;
+    /** When provided with violatedConstraints.recommendationPayload, enables "Show recommendations" and fetch */
+    generateRecommendationsURLAndHeaders?: {
+        url: string;
+        headers?: Record<string, string>;
+    };
+    styles?: Record<string, Record<string, unknown>>;
+    styleOverrides?: ViolatedConstraintsPanelStyleOverrides;
+};
+type SolveApiResponse = {
+    problemId: string;
+    solution: ScheduleSolution;
+    explanation: {
+        isFeasible: boolean;
+        violations: Array<{
+            constraintName?: string;
+            description?: string;
+            affectedEntities?: string[];
+            ruleId?: string;
+            archetype?: string;
+            jurisdiction?: string | null;
+            penalty?: string;
+            isHardViolation?: boolean;
+        }>;
+        summary?: string;
+    };
+    complianceReport?: unknown;
+};
+type ScheduleRecommendation = {
+    hard_violation_identified: string;
+    root_cause: string;
+    recommendation: string;
+    why_this_resolves_it: string;
+};
+
+declare function AutoSchedulerModal({ baseURL, isOpen, title, bannerText, jurisdictions, openShifts, employees, timeOffs, locationPlaceholder, onClose, cancelLabel, primaryActionLabel, onPrimaryAction: _onPrimaryAction, onFixManually, initialConfig, theme, cssVarsRoot, generateRecommendationsURLAndHeaders, onSolution, }: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Self-contained AutoSchedulerModal that wraps itself in ChakraProvider.
+ * Use this when the host app may have multiple React instances (e.g. local packages in Next.js),
+ * which can cause "Cannot read properties of null (reading 'useContext')" when using Chakra's useTheme.
+ */
+declare function AutoSchedulerModalWithProvider(props: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
+
+declare function ViolatedConstraintsPanel({ violatedConstraints, title, subtitle, showSecondaryButton, secondaryButtonTitle, onSecondaryButtonClick, generateRecommendationsURLAndHeaders, styles: stylesProp, styleOverrides, }: ViolatedConstraintsPanelProps): react_jsx_runtime.JSX.Element;
+
+declare function ViolatedConstraintsPanelWithProvider(props: ViolatedConstraintsPanelProps): react_jsx_runtime.JSX.Element;
+
+declare function buildRulesPayload(selectedConstraintIds: string[], constraintValues: Record<string, string>, selectedOptimizationIds: string[], optimizationValues: Record<string, string>): {
+    ruleIds?: string[];
+    ruleOverrides?: RuleOverrideEntry[];
+};
+type BuildSchedulePayloadInput = {
+    employees: Employee[];
+    openShifts: OpenShift[];
+    timeOffs?: TimeOff[];
+    selectedLocationIds: string[];
+    jurisdictions: JurisdictionGroup[];
+    selectedConstraintIds: string[];
+    constraintValues: Record<string, string>;
+    selectedOptimizationIds: string[];
+    optimizationValues: Record<string, string>;
+};
+declare function buildSchedulePayload(input: BuildSchedulePayloadInput): SchedulePayload;
+
+/**
+ * Returns a user-friendly display name for a ruleId or constraintName.
+ * Falls back to humanizing the raw string (replace - with spaces, capitalize) for unknown values.
+ */
+declare function getFriendlyRuleName(ruleIdOrConstraintName: string): string;
+
+export { AutoSchedulerModal, type AutoSchedulerModalConfig, type AutoSchedulerModalProps, type AutoSchedulerModalStyleOverrides, type AutoSchedulerModalTheme, AutoSchedulerModalWithProvider, type BuildSchedulePayloadInput, type EasyTeamThemeOverrides, type Employee, type EmployeeProperties, type JurisdictionGroup, type LocationOption, type OpenShift, type RecommendationPayload, RequestError, type RuleOverrideEntry, type SchedulePayload, type ScheduleRecommendation, type ScheduleSolution, type ScheduleSolutionAvailability, type ScheduleSolutionEmployee, type ScheduleSolutionLocation, type ScheduleSolutionRuleMetadata, type ScheduleSolutionRuleOverride, type ScheduleSolutionShift, type ScheduleSolutionShiftAssignment, type ScheduleSolutionTimeOff, type ScheduleSolutionWaiver, type Screen, type ShiftAssignmentJustification, type SolveApiExplanation, type SolveApiResponse, type StepStatus, type TimeOff, ViolatedConstraintsPanel, type ViolatedConstraintsPanelProps, type ViolatedConstraintsPanelStyleOverrides, ViolatedConstraintsPanelWithProvider, type ViolatedConstraintsResult, buildRulesPayload, buildSchedulePayload, getFriendlyRuleName };