@easyteam/auto-scheduler-modal-ui 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
 import { ThemeOverride } from '@chakra-ui/react';
 
 declare class RequestError extends Error {
@@ -131,8 +132,17 @@ type EmployeeProperties = {
     worker_type: string;
     costToRevenueRatio?: number;
     avgSalesAmount?: number;
+    /** Integer basis points (e.g. 1234 = 12.34%). Omit when unknown. */
+    conversionRate?: number;
     [key: string]: object | string | number | boolean | undefined;
 };
+/** One hourly traffic cell for the solver TrafficForecast fact (location-local). */
+type TrafficForecastEntry = {
+    locationId: string;
+    date: string;
+    hour: number;
+    visits: number;
+};
 type Employee = {
     id: string;
     name: string;
@@ -250,10 +260,88 @@ type AutoSchedulerModalTheme = (ThemeOverride & {
 }) | (EasyTeamThemeOverrides & {
     autoSchedulerModal?: AutoSchedulerModalStyleOverrides;
 });
+type SubLocationOption = {
+    id: string;
+    name: string;
+    parentId: string;
+};
+type TeamOption = {
+    id: string;
+    name: string;
+    resources: {
+        id: string;
+        externalEmployeeId?: string;
+        type?: string;
+        properties?: {
+            name?: string;
+        } & Record<string, unknown>;
+        [key: string]: unknown;
+    }[];
+};
+type HardConstraintOption = {
+    id: string;
+    name: string;
+    /** Shows this option as selected without requiring user interaction. */
+    defaultSelected?: boolean;
+    /** Prevents changing an implicitly selected option in the scheduler drawer. */
+    readOnly?: boolean;
+    /** When present, the modal shows a numeric input on selection. */
+    defaultValue?: string;
+    /** Label next to the input, e.g. 'hours' or 'days'. Defaults to 'hours'. */
+    suffix?: string;
+    min?: number;
+    max?: number;
+    /** Used as violation message detail when the solver reports this constraint as violated. */
+    description?: string;
+};
+type SoftConstraintOption = {
+    id: string;
+    title: string;
+    /** Shows this option as selected without requiring user interaction. */
+    defaultSelected?: boolean;
+    /** Prevents changing an implicitly selected option in the scheduler drawer. */
+    readOnly?: boolean;
+    /** Shown below the title in the picker. Also used as violation message detail. */
+    subtitle?: string;
+};
+type SoftConstraintGroup = {
+    id: string;
+    name: string;
+    options: SoftConstraintOption[];
+};
+type BuiltinConstraintOption = {
+    id: string;
+    title: string;
+    subtitle?: string;
+    category?: string;
+    defaultSelected?: boolean;
+};
+type GenerateScheduleConfig = {
+    selectedLocationIds: string[];
+    selectedSubLocationIds: string[];
+    selectedTeamIds: string[];
+    /** IANA timezone resolved from the selected drawer location. */
+    schedulerTimezone?: string;
+    /** Calendar dates YYYY-MM-DD within the viewed week to include in workflow evaluation and solver optimization */
+    selectedScheduleDates: string[];
+    selectedConstraintIds: string[];
+    constraintValues: Record<string, string>;
+    selectedOptimizationIds: string[];
+    optimizationValues: Record<string, string>;
+    /** Opt-in built-in Timefold constraint slugs (not org visual-rule UUIDs). */
+    selectedBuiltinIds?: string[];
+};
 type AutoSchedulerModalProps = {
-    baseURL: string;
+    /** Controls whether the component renders as a modal or a right-side drawer */
+    displayMode?: 'modal' | 'drawer';
+    /** Width of the drawer when displayMode="drawer". "sm"=448px, "md"=578px, "lg"=600px. Defaults to "lg". */
+    drawerSize?: 'sm' | 'md' | 'lg';
+    /** When true, the drawer fills 100% viewport height. Defaults to false. */
+    drawerFullHeight?: boolean;
+    baseURL?: string;
     isOpen: boolean;
     title?: string;
+    bannerTitle?: string;
     bannerText?: string;
     jurisdictions: JurisdictionGroup[];
     employees: Employee[];
@@ -270,23 +358,94 @@ type AutoSchedulerModalProps = {
     };
     theme?: AutoSchedulerModalTheme;
     cssVarsRoot?: string;
-    generateRecommendationsURLAndHeaders: {
+    generateRecommendationsURLAndHeaders?: {
         url: string;
         headers?: Record<string, string>;
     };
-    getTokenURLAndHeaders: {
+    getTokenURLAndHeaders?: {
         url: string;
         headers?: Record<string, string>;
     };
-    onSolution: (solution: ScheduleSolution) => Promise<void>;
+    onSolution?: (solution: ScheduleSolution) => Promise<void>;
     /** When provided, fetches stored config for a location set to prefill the form */
     getStoredConfigForLocations?: (locationIds: string[]) => AutoSchedulerModalConfig | null;
     /** When provided, persists config after successful schedule creation */
     persistConfigForLocations?: (locationIds: string[], config: AutoSchedulerModalConfig) => void;
     errorToast?: (msg: string) => void;
+    /** Organization id — required when sending visual rule ids */
+    organizationId?: string;
+    /** Visual rule ids attached to this solve (production path) */
+    constraintDefinitionIds?: string[];
+    /** Inline visual rule definitions (sandbox/test path; for unsaved rules) */
+    constraintDefinitions?: unknown[];
+    /** Replaces the built-in hard constraint list shown in "Required rules". */
+    hardConstraintOptions?: HardConstraintOption[];
+    /** Replaces the built-in optimization groups shown in "Optimization". */
+    softConstraintGroups?: SoftConstraintGroup[];
+    /** Optional footer under Optimization (e.g. host-owned Avia attribution). Prefer a render fn when showing in multiple places. */
+    optimizationFooter?: ReactNode | (() => ReactNode);
+    /**
+     * Hourly traffic forecast for the solve week (location-local).
+     * When Maximize Sales is selected and this is non-empty, the modal injects
+     * traffic-forecast-incentive and serializes this field on the solve payload.
+     */
+    trafficForecast?: TrafficForecastEntry[];
+    /** Opt-in built-in Timefold constraints (solver catalog slugs). */
+    builtinConstraintOptions?: BuiltinConstraintOption[];
+    /** All sub-locations (with parentId). The component filters them internally based on selected location IDs. */
+    subLocations?: SubLocationOption[];
+    /** When true, renders the sub-locations multiselect (filtered by selected locations). Defaults to false. */
+    showSubLocations?: boolean;
+    /** Teams list. The caller should update this reactively in response to onSelectionChange. */
+    teams?: TeamOption[];
+    /** When true, renders the teams multiselect. Defaults to false. */
+    showTeams?: boolean;
+    /**
+     * Called when the user changes location or sub-location selection.
+     * Use this to re-fetch teams filtered by the new selection.
+     */
+    onSelectionChange?: (locationIds: string[], subLocationIds: string[]) => void;
+    /**
+     * When provided, replaces the Java solver flow entirely.
+     * The component shows the progress animation and calls this function at step 1.
+     * Resolving means success (the resolved value is forwarded to onGenerateSolution);
+     * throwing means failure (shown in the failed screen).
+     */
+    onGenerate?: (config: GenerateScheduleConfig) => Promise<unknown>;
+    /**
+     * Called after onGenerate resolves successfully, just before the drawer/modal closes.
+     * Receives the value returned by onGenerate.
+     */
+    onGenerateSolution?: (result: unknown) => void;
+    /**
+     * Calendar week-start date YYYY-MM-DD (matches ops weekly schedule / evaluate-range window).
+     * When `onGenerate` is used, pass the week currently shown on the schedule grid.
+     */
+    scheduleWeekStartYmd?: string;
+    /**
+     * Today's civil date YYYY-MM-DD in `evaluationTimezone`, used to leave past week days unselected by default.
+     */
+    todayCalendarYmd?: string;
+    /**
+     * IANA timezone for interpreting today + backend evaluate-range date filtering (defaults to UTC).
+     */
+    evaluationTimezone?: string;
+    /**
+     * Live status of the underlying solve job. When set to "QUEUED" while the
+     * progress UI is visible, step 2's caption is replaced with "Waiting in queue…".
+     * Any other value (or null/undefined) leaves the step copy unchanged.
+     */
+    solveStatus?: SolveJobStatus | null;
 };
 type Screen = "configure" | "creating" | "failed";
 type StepStatus = "pending" | "active" | "done";
+/**
+ * Status of an async solve job, as reported by the scheduler service.
+ * QUEUED  → waiting for a solver slot
+ * SOLVING_ACTIVE → solver is running
+ * NOT_SOLVING / TERMINATED_EARLY → terminal
+ */
+type SolveJobStatus = "QUEUED" | "SOLVING_ACTIVE" | "NOT_SOLVING" | "TERMINATED_EARLY";
 type RuleOverrideEntry = {
     ruleId: string;
     parameters?: Record<string, unknown>;
@@ -323,10 +482,16 @@ type SchedulePayload = {
         timezone?: string;
         jurisdiction?: string;
         tags?: string[];
+        properties?: Record<string, unknown>;
     }>;
     timeOffs?: TimeOff[];
     ruleIds?: string[];
     ruleOverrides?: RuleOverrideEntry[];
+    /** Hourly traffic forecast problem fact (omit when unused). */
+    trafficForecast?: TrafficForecastEntry[];
+    constraintDefinitionIds?: string[];
+    constraintDefinitions?: unknown[];
+    organizationId?: string;
 };
 type AutoSchedulerModalConfig = {
     selectedLocationIds: string[];
@@ -334,6 +499,7 @@ type AutoSchedulerModalConfig = {
     constraintValues: Record<string, string>;
     selectedOptimizationIds: string[];
     optimizationValues: Record<string, string>;
+    selectedBuiltinIds?: string[];
 };
 type SolveApiExplanation = SolveApiResponse["explanation"];
 /** Full POST body for the getRecommendationURL API (context, locations, employees, shifts, etc.) */
@@ -404,8 +570,12 @@ type ScheduleRecommendation = {
     recommendation: string;
     why_this_resolves_it: string;
 };
+declare class InfeasibleScheduleError extends Error {
+    readonly failure: ViolatedConstraintsResult;
+    constructor(failure: ViolatedConstraintsResult);
+}
 
-declare function AutoSchedulerModal({ baseURL, isOpen, title, bannerText, jurisdictions, openShifts, employees, timeOffs, locationPlaceholder, onClose, cancelLabel, primaryActionLabel, onPrimaryAction: _onPrimaryAction, onFixManually, initialConfig, theme, cssVarsRoot, generateRecommendationsURLAndHeaders, getTokenURLAndHeaders, onSolution, getStoredConfigForLocations, persistConfigForLocations, errorToast, }: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
+declare function AutoSchedulerModal({ displayMode, drawerSize, baseURL, isOpen, title, bannerTitle, bannerText, jurisdictions, openShifts, employees, timeOffs, locationPlaceholder, onClose, cancelLabel, primaryActionLabel, onPrimaryAction: _onPrimaryAction, onFixManually, initialConfig, theme, cssVarsRoot, generateRecommendationsURLAndHeaders, getTokenURLAndHeaders, onSolution, getStoredConfigForLocations, persistConfigForLocations, errorToast, organizationId, constraintDefinitionIds, constraintDefinitions, hardConstraintOptions, softConstraintGroups, optimizationFooter, trafficForecast, builtinConstraintOptions, subLocations, showSubLocations, teams, showTeams, onSelectionChange, onGenerate, onGenerateSolution, solveStatus, scheduleWeekStartYmd, todayCalendarYmd, evaluationTimezone, }: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Self-contained AutoSchedulerModal that wraps itself in ChakraProvider.
@@ -418,7 +588,21 @@ declare function ViolatedConstraintsPanel({ violatedConstraints, title, subtitle
 
 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>): {
+/** Soft companion for conversion rate — silent inject under Maximize Sales / Cost-to-sales. */
+declare const MAXIMIZE_CONVERSION_RATE_RULE_ID = "maximize-conversion-rate";
+/** Soft companion for traffic × sales — silent inject under Maximize Sales only. */
+declare const TRAFFIC_FORECAST_INCENTIVE_RULE_ID = "traffic-forecast-incentive";
+type SiblingRuleOptions = {
+    /** Inject maximize-conversion-rate when sales opts are selected. */
+    includeConversionRate?: boolean;
+    /** Inject traffic-forecast-incentive when Maximize Sales is selected. */
+    includeTrafficIncentive?: boolean;
+};
+/**
+ * Build ruleIds / ruleOverrides. Sibling Avia-agnostic rules are appended into
+ * whichever structure is returned (Maximize Sales forces the overrides path).
+ */
+declare function buildRulesPayload(selectedConstraintIds: string[], constraintValues: Record<string, string>, selectedOptimizationIds: string[], optimizationValues: Record<string, string>, siblings?: SiblingRuleOptions): {
     ruleIds?: string[];
     ruleOverrides?: RuleOverrideEntry[];
 };
@@ -432,6 +616,10 @@ type BuildSchedulePayloadInput = {
     constraintValues: Record<string, string>;
     selectedOptimizationIds: string[];
     optimizationValues: Record<string, string>;
+    trafficForecast?: TrafficForecastEntry[];
+    constraintDefinitionIds?: string[];
+    constraintDefinitions?: unknown[];
+    organizationId?: string;
 };
 declare function buildSchedulePayload(input: BuildSchedulePayloadInput): SchedulePayload;
 
@@ -441,4 +629,11 @@ declare function buildSchedulePayload(input: BuildSchedulePayloadInput): Schedul
  */
 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 };
+/** Seven consecutive calendar days starting at `weekStartYmd` (already aligned to org week start). */
+declare function getSequentialWeekDatesFromWeekStart(weekStartYmd: string): string[];
+/** Calendar-day weekday chip Su … Sa following JS getDay() order (0 = Sun). */
+declare function weekdayTwoLetterFromYmd(ymd: string): string;
+/** Defaults to all week dates strictly on or after `todayYmd` (ISO date string compare). */
+declare function defaultSelectedScheduleDates(orderedWeekYmds: string[], todayYmd: string): string[];
+
+export { AutoSchedulerModal, type AutoSchedulerModalConfig, type AutoSchedulerModalProps, type AutoSchedulerModalStyleOverrides, type AutoSchedulerModalTheme, AutoSchedulerModalWithProvider, type BuildSchedulePayloadInput, type BuiltinConstraintOption, type EasyTeamThemeOverrides, type Employee, type EmployeeProperties, type GenerateScheduleConfig, type HardConstraintOption, InfeasibleScheduleError, type JurisdictionGroup, type LocationOption, MAXIMIZE_CONVERSION_RATE_RULE_ID, 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 SiblingRuleOptions, type SoftConstraintGroup, type SoftConstraintOption, type SolveApiExplanation, type SolveApiResponse, type SolveJobStatus, type StepStatus, type SubLocationOption, TRAFFIC_FORECAST_INCENTIVE_RULE_ID, type TeamOption, type TimeOff, type TrafficForecastEntry, ViolatedConstraintsPanel, type ViolatedConstraintsPanelProps, type ViolatedConstraintsPanelStyleOverrides, ViolatedConstraintsPanelWithProvider, type ViolatedConstraintsResult, buildRulesPayload, buildSchedulePayload, defaultSelectedScheduleDates, getFriendlyRuleName, getSequentialWeekDatesFromWeekStart, weekdayTwoLetterFromYmd };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
 import { ThemeOverride } from '@chakra-ui/react';
 
 declare class RequestError extends Error {
@@ -131,8 +132,17 @@ type EmployeeProperties = {
     worker_type: string;
     costToRevenueRatio?: number;
     avgSalesAmount?: number;
+    /** Integer basis points (e.g. 1234 = 12.34%). Omit when unknown. */
+    conversionRate?: number;
     [key: string]: object | string | number | boolean | undefined;
 };
+/** One hourly traffic cell for the solver TrafficForecast fact (location-local). */
+type TrafficForecastEntry = {
+    locationId: string;
+    date: string;
+    hour: number;
+    visits: number;
+};
 type Employee = {
     id: string;
     name: string;
@@ -250,10 +260,88 @@ type AutoSchedulerModalTheme = (ThemeOverride & {
 }) | (EasyTeamThemeOverrides & {
     autoSchedulerModal?: AutoSchedulerModalStyleOverrides;
 });
+type SubLocationOption = {
+    id: string;
+    name: string;
+    parentId: string;
+};
+type TeamOption = {
+    id: string;
+    name: string;
+    resources: {
+        id: string;
+        externalEmployeeId?: string;
+        type?: string;
+        properties?: {
+            name?: string;
+        } & Record<string, unknown>;
+        [key: string]: unknown;
+    }[];
+};
+type HardConstraintOption = {
+    id: string;
+    name: string;
+    /** Shows this option as selected without requiring user interaction. */
+    defaultSelected?: boolean;
+    /** Prevents changing an implicitly selected option in the scheduler drawer. */
+    readOnly?: boolean;
+    /** When present, the modal shows a numeric input on selection. */
+    defaultValue?: string;
+    /** Label next to the input, e.g. 'hours' or 'days'. Defaults to 'hours'. */
+    suffix?: string;
+    min?: number;
+    max?: number;
+    /** Used as violation message detail when the solver reports this constraint as violated. */
+    description?: string;
+};
+type SoftConstraintOption = {
+    id: string;
+    title: string;
+    /** Shows this option as selected without requiring user interaction. */
+    defaultSelected?: boolean;
+    /** Prevents changing an implicitly selected option in the scheduler drawer. */
+    readOnly?: boolean;
+    /** Shown below the title in the picker. Also used as violation message detail. */
+    subtitle?: string;
+};
+type SoftConstraintGroup = {
+    id: string;
+    name: string;
+    options: SoftConstraintOption[];
+};
+type BuiltinConstraintOption = {
+    id: string;
+    title: string;
+    subtitle?: string;
+    category?: string;
+    defaultSelected?: boolean;
+};
+type GenerateScheduleConfig = {
+    selectedLocationIds: string[];
+    selectedSubLocationIds: string[];
+    selectedTeamIds: string[];
+    /** IANA timezone resolved from the selected drawer location. */
+    schedulerTimezone?: string;
+    /** Calendar dates YYYY-MM-DD within the viewed week to include in workflow evaluation and solver optimization */
+    selectedScheduleDates: string[];
+    selectedConstraintIds: string[];
+    constraintValues: Record<string, string>;
+    selectedOptimizationIds: string[];
+    optimizationValues: Record<string, string>;
+    /** Opt-in built-in Timefold constraint slugs (not org visual-rule UUIDs). */
+    selectedBuiltinIds?: string[];
+};
 type AutoSchedulerModalProps = {
-    baseURL: string;
+    /** Controls whether the component renders as a modal or a right-side drawer */
+    displayMode?: 'modal' | 'drawer';
+    /** Width of the drawer when displayMode="drawer". "sm"=448px, "md"=578px, "lg"=600px. Defaults to "lg". */
+    drawerSize?: 'sm' | 'md' | 'lg';
+    /** When true, the drawer fills 100% viewport height. Defaults to false. */
+    drawerFullHeight?: boolean;
+    baseURL?: string;
     isOpen: boolean;
     title?: string;
+    bannerTitle?: string;
     bannerText?: string;
     jurisdictions: JurisdictionGroup[];
     employees: Employee[];
@@ -270,23 +358,94 @@ type AutoSchedulerModalProps = {
     };
     theme?: AutoSchedulerModalTheme;
     cssVarsRoot?: string;
-    generateRecommendationsURLAndHeaders: {
+    generateRecommendationsURLAndHeaders?: {
         url: string;
         headers?: Record<string, string>;
     };
-    getTokenURLAndHeaders: {
+    getTokenURLAndHeaders?: {
         url: string;
         headers?: Record<string, string>;
     };
-    onSolution: (solution: ScheduleSolution) => Promise<void>;
+    onSolution?: (solution: ScheduleSolution) => Promise<void>;
     /** When provided, fetches stored config for a location set to prefill the form */
     getStoredConfigForLocations?: (locationIds: string[]) => AutoSchedulerModalConfig | null;
     /** When provided, persists config after successful schedule creation */
     persistConfigForLocations?: (locationIds: string[], config: AutoSchedulerModalConfig) => void;
     errorToast?: (msg: string) => void;
+    /** Organization id — required when sending visual rule ids */
+    organizationId?: string;
+    /** Visual rule ids attached to this solve (production path) */
+    constraintDefinitionIds?: string[];
+    /** Inline visual rule definitions (sandbox/test path; for unsaved rules) */
+    constraintDefinitions?: unknown[];
+    /** Replaces the built-in hard constraint list shown in "Required rules". */
+    hardConstraintOptions?: HardConstraintOption[];
+    /** Replaces the built-in optimization groups shown in "Optimization". */
+    softConstraintGroups?: SoftConstraintGroup[];
+    /** Optional footer under Optimization (e.g. host-owned Avia attribution). Prefer a render fn when showing in multiple places. */
+    optimizationFooter?: ReactNode | (() => ReactNode);
+    /**
+     * Hourly traffic forecast for the solve week (location-local).
+     * When Maximize Sales is selected and this is non-empty, the modal injects
+     * traffic-forecast-incentive and serializes this field on the solve payload.
+     */
+    trafficForecast?: TrafficForecastEntry[];
+    /** Opt-in built-in Timefold constraints (solver catalog slugs). */
+    builtinConstraintOptions?: BuiltinConstraintOption[];
+    /** All sub-locations (with parentId). The component filters them internally based on selected location IDs. */
+    subLocations?: SubLocationOption[];
+    /** When true, renders the sub-locations multiselect (filtered by selected locations). Defaults to false. */
+    showSubLocations?: boolean;
+    /** Teams list. The caller should update this reactively in response to onSelectionChange. */
+    teams?: TeamOption[];
+    /** When true, renders the teams multiselect. Defaults to false. */
+    showTeams?: boolean;
+    /**
+     * Called when the user changes location or sub-location selection.
+     * Use this to re-fetch teams filtered by the new selection.
+     */
+    onSelectionChange?: (locationIds: string[], subLocationIds: string[]) => void;
+    /**
+     * When provided, replaces the Java solver flow entirely.
+     * The component shows the progress animation and calls this function at step 1.
+     * Resolving means success (the resolved value is forwarded to onGenerateSolution);
+     * throwing means failure (shown in the failed screen).
+     */
+    onGenerate?: (config: GenerateScheduleConfig) => Promise<unknown>;
+    /**
+     * Called after onGenerate resolves successfully, just before the drawer/modal closes.
+     * Receives the value returned by onGenerate.
+     */
+    onGenerateSolution?: (result: unknown) => void;
+    /**
+     * Calendar week-start date YYYY-MM-DD (matches ops weekly schedule / evaluate-range window).
+     * When `onGenerate` is used, pass the week currently shown on the schedule grid.
+     */
+    scheduleWeekStartYmd?: string;
+    /**
+     * Today's civil date YYYY-MM-DD in `evaluationTimezone`, used to leave past week days unselected by default.
+     */
+    todayCalendarYmd?: string;
+    /**
+     * IANA timezone for interpreting today + backend evaluate-range date filtering (defaults to UTC).
+     */
+    evaluationTimezone?: string;
+    /**
+     * Live status of the underlying solve job. When set to "QUEUED" while the
+     * progress UI is visible, step 2's caption is replaced with "Waiting in queue…".
+     * Any other value (or null/undefined) leaves the step copy unchanged.
+     */
+    solveStatus?: SolveJobStatus | null;
 };
 type Screen = "configure" | "creating" | "failed";
 type StepStatus = "pending" | "active" | "done";
+/**
+ * Status of an async solve job, as reported by the scheduler service.
+ * QUEUED  → waiting for a solver slot
+ * SOLVING_ACTIVE → solver is running
+ * NOT_SOLVING / TERMINATED_EARLY → terminal
+ */
+type SolveJobStatus = "QUEUED" | "SOLVING_ACTIVE" | "NOT_SOLVING" | "TERMINATED_EARLY";
 type RuleOverrideEntry = {
     ruleId: string;
     parameters?: Record<string, unknown>;
@@ -323,10 +482,16 @@ type SchedulePayload = {
         timezone?: string;
         jurisdiction?: string;
         tags?: string[];
+        properties?: Record<string, unknown>;
     }>;
     timeOffs?: TimeOff[];
     ruleIds?: string[];
     ruleOverrides?: RuleOverrideEntry[];
+    /** Hourly traffic forecast problem fact (omit when unused). */
+    trafficForecast?: TrafficForecastEntry[];
+    constraintDefinitionIds?: string[];
+    constraintDefinitions?: unknown[];
+    organizationId?: string;
 };
 type AutoSchedulerModalConfig = {
     selectedLocationIds: string[];
@@ -334,6 +499,7 @@ type AutoSchedulerModalConfig = {
     constraintValues: Record<string, string>;
     selectedOptimizationIds: string[];
     optimizationValues: Record<string, string>;
+    selectedBuiltinIds?: string[];
 };
 type SolveApiExplanation = SolveApiResponse["explanation"];
 /** Full POST body for the getRecommendationURL API (context, locations, employees, shifts, etc.) */
@@ -404,8 +570,12 @@ type ScheduleRecommendation = {
     recommendation: string;
     why_this_resolves_it: string;
 };
+declare class InfeasibleScheduleError extends Error {
+    readonly failure: ViolatedConstraintsResult;
+    constructor(failure: ViolatedConstraintsResult);
+}
 
-declare function AutoSchedulerModal({ baseURL, isOpen, title, bannerText, jurisdictions, openShifts, employees, timeOffs, locationPlaceholder, onClose, cancelLabel, primaryActionLabel, onPrimaryAction: _onPrimaryAction, onFixManually, initialConfig, theme, cssVarsRoot, generateRecommendationsURLAndHeaders, getTokenURLAndHeaders, onSolution, getStoredConfigForLocations, persistConfigForLocations, errorToast, }: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
+declare function AutoSchedulerModal({ displayMode, drawerSize, baseURL, isOpen, title, bannerTitle, bannerText, jurisdictions, openShifts, employees, timeOffs, locationPlaceholder, onClose, cancelLabel, primaryActionLabel, onPrimaryAction: _onPrimaryAction, onFixManually, initialConfig, theme, cssVarsRoot, generateRecommendationsURLAndHeaders, getTokenURLAndHeaders, onSolution, getStoredConfigForLocations, persistConfigForLocations, errorToast, organizationId, constraintDefinitionIds, constraintDefinitions, hardConstraintOptions, softConstraintGroups, optimizationFooter, trafficForecast, builtinConstraintOptions, subLocations, showSubLocations, teams, showTeams, onSelectionChange, onGenerate, onGenerateSolution, solveStatus, scheduleWeekStartYmd, todayCalendarYmd, evaluationTimezone, }: AutoSchedulerModalProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Self-contained AutoSchedulerModal that wraps itself in ChakraProvider.
@@ -418,7 +588,21 @@ declare function ViolatedConstraintsPanel({ violatedConstraints, title, subtitle
 
 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>): {
+/** Soft companion for conversion rate — silent inject under Maximize Sales / Cost-to-sales. */
+declare const MAXIMIZE_CONVERSION_RATE_RULE_ID = "maximize-conversion-rate";
+/** Soft companion for traffic × sales — silent inject under Maximize Sales only. */
+declare const TRAFFIC_FORECAST_INCENTIVE_RULE_ID = "traffic-forecast-incentive";
+type SiblingRuleOptions = {
+    /** Inject maximize-conversion-rate when sales opts are selected. */
+    includeConversionRate?: boolean;
+    /** Inject traffic-forecast-incentive when Maximize Sales is selected. */
+    includeTrafficIncentive?: boolean;
+};
+/**
+ * Build ruleIds / ruleOverrides. Sibling Avia-agnostic rules are appended into
+ * whichever structure is returned (Maximize Sales forces the overrides path).
+ */
+declare function buildRulesPayload(selectedConstraintIds: string[], constraintValues: Record<string, string>, selectedOptimizationIds: string[], optimizationValues: Record<string, string>, siblings?: SiblingRuleOptions): {
     ruleIds?: string[];
     ruleOverrides?: RuleOverrideEntry[];
 };
@@ -432,6 +616,10 @@ type BuildSchedulePayloadInput = {
     constraintValues: Record<string, string>;
     selectedOptimizationIds: string[];
     optimizationValues: Record<string, string>;
+    trafficForecast?: TrafficForecastEntry[];
+    constraintDefinitionIds?: string[];
+    constraintDefinitions?: unknown[];
+    organizationId?: string;
 };
 declare function buildSchedulePayload(input: BuildSchedulePayloadInput): SchedulePayload;
 
@@ -441,4 +629,11 @@ declare function buildSchedulePayload(input: BuildSchedulePayloadInput): Schedul
  */
 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 };
+/** Seven consecutive calendar days starting at `weekStartYmd` (already aligned to org week start). */
+declare function getSequentialWeekDatesFromWeekStart(weekStartYmd: string): string[];
+/** Calendar-day weekday chip Su … Sa following JS getDay() order (0 = Sun). */
+declare function weekdayTwoLetterFromYmd(ymd: string): string;
+/** Defaults to all week dates strictly on or after `todayYmd` (ISO date string compare). */
+declare function defaultSelectedScheduleDates(orderedWeekYmds: string[], todayYmd: string): string[];
+
+export { AutoSchedulerModal, type AutoSchedulerModalConfig, type AutoSchedulerModalProps, type AutoSchedulerModalStyleOverrides, type AutoSchedulerModalTheme, AutoSchedulerModalWithProvider, type BuildSchedulePayloadInput, type BuiltinConstraintOption, type EasyTeamThemeOverrides, type Employee, type EmployeeProperties, type GenerateScheduleConfig, type HardConstraintOption, InfeasibleScheduleError, type JurisdictionGroup, type LocationOption, MAXIMIZE_CONVERSION_RATE_RULE_ID, 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 SiblingRuleOptions, type SoftConstraintGroup, type SoftConstraintOption, type SolveApiExplanation, type SolveApiResponse, type SolveJobStatus, type StepStatus, type SubLocationOption, TRAFFIC_FORECAST_INCENTIVE_RULE_ID, type TeamOption, type TimeOff, type TrafficForecastEntry, ViolatedConstraintsPanel, type ViolatedConstraintsPanelProps, type ViolatedConstraintsPanelStyleOverrides, ViolatedConstraintsPanelWithProvider, type ViolatedConstraintsResult, buildRulesPayload, buildSchedulePayload, defaultSelectedScheduleDates, getFriendlyRuleName, getSequentialWeekDatesFromWeekStart, weekdayTwoLetterFromYmd };