@medplum/react-scheduling 5.1.30 → 5.1.31

package/dist/cjs/index.d.ts

@@ -2,13 +2,65 @@ import type { Appointment } from '@medplum/fhirtypes';
 import type { HealthcareService } from '@medplum/fhirtypes';
 import type { HealthcareServiceAvailableTime } from '@medplum/fhirtypes';
 import type { JSX } from 'react';
+import type { Location as Location_2 } from '@medplum/fhirtypes';
+import type { MedplumClient } from '@medplum/core';
 import type { Reference } from '@medplum/fhirtypes';
+import type { Resource } from '@medplum/fhirtypes';
 import type { Schedule } from '@medplum/fhirtypes';
 import type { Slot } from '@medplum/fhirtypes';
 import type { WithId } from '@medplum/core';
 
+/**
+ * One way of holding an appointment: a set of actors whose schedules `$find`
+ * intersects in a single request. A role contributes as many actors as were
+ * chosen for it, since everything chosen attends.
+ */
+export declare interface ActorCombination {
+    /** Matches `getActorGroupKey` of the appointments offered for these actors. */
+    readonly key: string;
+    readonly label: string;
+    readonly actors: readonly SchedulingActor[];
+    readonly schedules: readonly Reference<Schedule>[];
+}
+
+/**
+ * What an appointment is being asked for: the schedules chosen, per role.
+ * Everything named attends.
+ */
+export declare type ActorSelections = Partial<Record<SchedulingRole, readonly ScheduleCandidate[]>>;
+
 export declare function addDays(date: Date, days: number): Date;
 
+/**
+ * Chooses the actors an appointment is held on, for one role.
+ *
+ * Everything chosen attends: `$find` intersects the schedules behind them,
+ * so naming a second actor narrows the times to the ones both are free for.
+ *
+ * Schedules are searched for as the name is typed (via `AsyncAutocomplete`).
+ *
+ * @param props - The React props.
+ * @returns The field for one role.
+ */
+export declare function AppointmentActorSelect(props: AppointmentActorSelectProps): JSX.Element;
+
+export declare interface AppointmentActorSelectProps {
+    /** The role being filled. */
+    readonly role: SchedulingRole;
+    /** The service being booked. Nothing is offered until it resolves. */
+    readonly service: Reference<HealthcareService> | WithId<HealthcareService> | undefined;
+    /**
+     * The site being booked at. Actors sited elsewhere are left out: a room or a
+     * device anywhere inside it counts, a provider only if one of their
+     * PractitionerRoles names it.
+     */
+    readonly location?: Reference<Location_2> | WithId<Location_2>;
+    readonly defaultValue?: readonly ScheduleCandidate[];
+    readonly onChange: (candidates: readonly ScheduleCandidate[]) => void;
+    readonly error?: string;
+    readonly disabled?: boolean;
+}
+
 export declare interface AppointmentDay {
     /** `YYYY-MM-DD` in the scheduling timezone. */
     readonly key: string;
@@ -39,6 +91,42 @@ export declare interface AppointmentDayTimesProps {
     readonly selected?: Appointment;
 }
 
+/**
+ * One option in an appointment pick list: what it is called, over what tells it
+ * apart from the others.
+ * @param props - The React props.
+ * @returns The row.
+ */
+export declare function AppointmentOptionRow(props: AppointmentOptionRowProps): JSX.Element;
+
+export declare interface AppointmentOptionRowProps {
+    readonly label: string;
+    /** What tells this option apart from one of the same name. Omitted when there is nothing on file. */
+    readonly detail?: string;
+}
+
+/**
+ * Chooses the service an appointment is for.
+ *
+ * Only services configured for scheduling are offered. A `HealthcareService`
+ * without a `SchedulingParameters` extension has no duration or alignment for
+ * `$find` to work from, so booking against it cannot succeed.
+ *
+ * @param props - The React props.
+ * @returns The service field.
+ */
+export declare function AppointmentServiceSelect(props: AppointmentServiceSelectProps): JSX.Element;
+
+export declare interface AppointmentServiceSelectProps {
+    readonly defaultValue?: WithId<HealthcareService>;
+    readonly onChange: (service: WithId<HealthcareService> | undefined) => void;
+    /** A chosen site, which narrows the services on offer to the ones held there. */
+    readonly location?: WithId<Location_2> | Reference<Location_2>;
+    readonly label?: string;
+    readonly error?: string;
+    readonly disabled?: boolean;
+}
+
 /** A calendar day's worth of available times, split by the actors offering them. */
 export declare interface AppointmentSlotGroup {
     /** Stable key derived from the actors, so React keys survive a refetch. */
@@ -65,6 +153,17 @@ export declare interface AppointmentSlotGroupCardProps {
     readonly disabled?: boolean;
 }
 
+/**
+ * Actor types whose schedules may be offered for booking.
+ *
+ * Does not include `PractitionerRole` to prevent double-booking
+ * a `Practitioner` who holds multiple roles. See `getSchedulingRole` for how
+ * `PractitionerRole` is still used to determine eligibility for a schedule.
+ */
+export declare const BOOKABLE_ACTOR_TYPES: readonly ["Practitioner", "Location", "Device"];
+
+export declare type BookableActorType = (typeof BOOKABLE_ACTOR_TYPES)[number];
+
 export declare function Calendar(props: CalendarProps): JSX.Element;
 
 export declare interface CalendarProps {
@@ -135,6 +234,25 @@ export declare function enumerateDateRange(range: DateRange, limit?: number): Da
  */
 export declare function filterByTimeOfDay(appointments: readonly Appointment[], timeOfDay: TimeOfDay, timezone?: string): Appointment[];
 
+/**
+ * Narrows candidates to the ones available at one location.
+ *
+ * A candidate that says nothing about where it is, or whose ancestry cannot be
+ * read, is kept: hiding something the caller may be entitled to book is worse
+ * than offering something at the wrong site.
+ *
+ * @param medplum - The Medplum client.
+ * @param candidates - Candidates to narrow.
+ * @param location - The site being booked at, or undefined to keep everything.
+ * @param options - Abort signal.
+ * @returns The candidates, minus the ones sited elsewhere.
+ */
+export declare function filterCandidatesByLocation(medplum: MedplumClient, candidates: readonly ScheduleCandidate[], location: Reference<Location_2> | WithId<Location_2> | undefined, options?: FilterCandidatesOptions): Promise<ScheduleCandidate[]>;
+
+export declare interface FilterCandidatesOptions {
+    readonly signal?: AbortSignal;
+}
+
 /**
  * Says in words which days a search covers.
  * @param range - The days asked for.
@@ -157,6 +275,18 @@ export declare function formatDayHeading(date: Date): string;
  */
 export declare function formatZonedTime(date: Date, timezone?: string): string;
 
+/**
+ * Builds the sets of actors an appointment could be held on.
+ *
+ * One combination is one `$find` request: the schedules within it are
+ * intersected, so its times are the times all of those actors are free.
+ *
+ * @param selections - What has been chosen.
+ * @returns One combination holding every chosen actor, in role order, or an
+ *   empty list when nothing is chosen.
+ */
+export declare function getActorCombinations(selections: ActorSelections): ActorCombination[];
+
 /**
  * Builds a key identifying the set of actors an appointment is offered by.
  * @param appointment - The proposed appointment.
@@ -193,6 +323,20 @@ export declare function getActorsKey(actors: readonly Reference[]): string;
  */
 export declare function getAppointmentKey(appointment: Appointment): string;
 
+/**
+ * Names a candidate's actor, for use in plain-text option lists.
+ * @param candidate - The candidate to name.
+ * @returns The name to show.
+ */
+export declare function getCandidateDisplay(candidate: ScheduleCandidate): string;
+
+/**
+ * Returns the role a candidate fills, from the type of its actor.
+ * @param candidate - The candidate to read.
+ * @returns The role, or undefined for an actor of a type nothing books against.
+ */
+export declare function getCandidateRole(candidate: ScheduleCandidate): SchedulingRole | undefined;
+
 /**
  * Returns an appointment's length in whole minutes.
  * @param appointment - The proposed appointment.
@@ -241,6 +385,20 @@ export declare function getNativeInputType(type: 'date' | 'time'): string;
  */
 export declare function getSchedulingRole(actorType: SchedulingActorType): SchedulingRole;
 
+/**
+ * Returns everything chosen, across roles.
+ * @param selections - What has been chosen.
+ * @returns The chosen candidates, in `SCHEDULING_ROLES` order.
+ */
+export declare function getSelectedCandidates(selections: ActorSelections): ScheduleCandidate[];
+
+/**
+ * Reports why the current selections cannot be searched, if they cannot.
+ * @param selections - What has been chosen.
+ * @returns A message to show the user, or undefined when the search can run.
+ */
+export declare function getSelectionError(selections: ActorSelections): string | undefined;
+
 /**
  * Groups proposed appointments into days, and each day into the sets of actors
  * offering those times.
@@ -251,6 +409,15 @@ export declare function getSchedulingRole(actorType: SchedulingActorType): Sched
  */
 export declare function groupAppointmentsByDay(appointments: readonly Appointment[], timezone?: string): AppointmentDay[];
 
+export declare function isBookableActorType(value: string | undefined): value is BookableActorType;
+
+/**
+ * Reports whether a role has to be filled.
+ * @param role - The role being filled.
+ * @returns Whether a search can run without it.
+ */
+export declare function isRoleRequired(role: SchedulingRole): boolean;
+
 /**
  * Returns whether two instants fall on the same local day.
  * @param left - The first instant.
@@ -304,6 +471,16 @@ export declare function ScheduleAvailabilityEditor(props: ScheduleAvailabilityEd
  */
 export declare type ScheduleAvailabilityEditorProps = ScheduleOverrideEditorProps | ServiceDefaultEditorProps;
 
+/**
+ * A Schedule that can be booked for a service, paired with the actor it belongs
+ * to.
+ */
+export declare interface ScheduleCandidate {
+    readonly schedule: WithId<Schedule>;
+    /** The actor itself, when the search was able to include it. */
+    readonly actorResource: WithId<Resource> | undefined;
+}
+
 /**
  * Props for editing the availability override a Schedule holds for one service.
  * @param schedule - The Schedule holding the availability override. Must have exactly one actor, as scheduling requires.
@@ -338,6 +515,32 @@ export declare type SchedulingActorType = (typeof SCHEDULING_ACTOR_TYPES)[number
 
 export declare type SchedulingRole = (typeof SCHEDULING_ROLES)[number];
 
+/**
+ * Finds the Schedules that can be booked for one role of a HealthcareService,
+ * narrowed to the actors whose name matches what was typed.
+ * @param medplum - The Medplum client.
+ * @param service - The HealthcareService being booked.
+ * @param options - The role, the text typed, the site, an abort signal, and a page size.
+ * @returns The matching schedules, each with its actor, by display name.
+ */
+export declare function searchScheduleCandidates(medplum: MedplumClient, service: WithId<HealthcareService>, options: SearchScheduleCandidatesOptions): Promise<ScheduleCandidate[]>;
+
+export declare interface SearchScheduleCandidatesOptions {
+    /** Which of the service's actors to offer. */
+    readonly role: SchedulingRole;
+    /** What the user typed. Empty offers whatever the role has, unfiltered by name. */
+    readonly query: string;
+    /**
+     * The site being booked at. Actors sited elsewhere are left out: a room or a
+     * device anywhere inside it counts, a provider only if one of their
+     * PractitionerRoles names it.
+     */
+    readonly location?: Reference<Location_2> | WithId<Location_2>;
+    readonly signal?: AbortSignal;
+    /** Maximum schedules to consider. Defaults to 25. */
+    readonly count?: number;
+}
+
 /**
  * Props for editing a service's own default hours, in place of any one calendar's override.
  * @param schedule - Omitted, which is what selects this mode.
@@ -375,4 +578,34 @@ export declare function setScheduleAvailability(schedule: Schedule, service: Wit
 
 export declare type TimeOfDay = 'any' | 'morning' | 'afternoon';
 
+/**
+ * Searches for the times an appointment could be held at.
+ * @param options - The service, actor combinations, days, and page size.
+ * @returns The times offered, plus load and error state.
+ */
+export declare function useProposedAppointments(options: UseProposedAppointmentsOptions): UseProposedAppointmentsResult;
+
+export declare interface UseProposedAppointmentsOptions {
+    /** The service being booked, as a reference or the resource itself. */
+    readonly service: Reference<HealthcareService> | WithId<HealthcareService> | undefined;
+    /** The sets of actors to search for, from `getActorCombinations`. */
+    readonly combinations: readonly ActorCombination[];
+    /** The days to search. Both ends are needed; `$find` refuses an open range. */
+    readonly range: DateRange;
+    /** Times to ask for per combination. Defaults to 20. */
+    readonly count?: number;
+}
+
+export declare interface UseProposedAppointmentsResult {
+    /**
+     * Every time offered, never persisted — `$find` proposes.
+     */
+    readonly appointments: readonly Appointment[];
+    /** How many `$find` requests the current combinations take. */
+    readonly requestCount: number;
+    readonly loading: boolean;
+    /** Set only when every combination failed. */
+    readonly error: Error | undefined;
+}
+
 export { }

package/dist/esm/index.d.ts

@@ -2,13 +2,65 @@ import type { Appointment } from '@medplum/fhirtypes';
 import type { HealthcareService } from '@medplum/fhirtypes';
 import type { HealthcareServiceAvailableTime } from '@medplum/fhirtypes';
 import type { JSX } from 'react';
+import type { Location as Location_2 } from '@medplum/fhirtypes';
+import type { MedplumClient } from '@medplum/core';
 import type { Reference } from '@medplum/fhirtypes';
+import type { Resource } from '@medplum/fhirtypes';
 import type { Schedule } from '@medplum/fhirtypes';
 import type { Slot } from '@medplum/fhirtypes';
 import type { WithId } from '@medplum/core';
 
+/**
+ * One way of holding an appointment: a set of actors whose schedules `$find`
+ * intersects in a single request. A role contributes as many actors as were
+ * chosen for it, since everything chosen attends.
+ */
+export declare interface ActorCombination {
+    /** Matches `getActorGroupKey` of the appointments offered for these actors. */
+    readonly key: string;
+    readonly label: string;
+    readonly actors: readonly SchedulingActor[];
+    readonly schedules: readonly Reference<Schedule>[];
+}
+
+/**
+ * What an appointment is being asked for: the schedules chosen, per role.
+ * Everything named attends.
+ */
+export declare type ActorSelections = Partial<Record<SchedulingRole, readonly ScheduleCandidate[]>>;
+
 export declare function addDays(date: Date, days: number): Date;
 
+/**
+ * Chooses the actors an appointment is held on, for one role.
+ *
+ * Everything chosen attends: `$find` intersects the schedules behind them,
+ * so naming a second actor narrows the times to the ones both are free for.
+ *
+ * Schedules are searched for as the name is typed (via `AsyncAutocomplete`).
+ *
+ * @param props - The React props.
+ * @returns The field for one role.
+ */
+export declare function AppointmentActorSelect(props: AppointmentActorSelectProps): JSX.Element;
+
+export declare interface AppointmentActorSelectProps {
+    /** The role being filled. */
+    readonly role: SchedulingRole;
+    /** The service being booked. Nothing is offered until it resolves. */
+    readonly service: Reference<HealthcareService> | WithId<HealthcareService> | undefined;
+    /**
+     * The site being booked at. Actors sited elsewhere are left out: a room or a
+     * device anywhere inside it counts, a provider only if one of their
+     * PractitionerRoles names it.
+     */
+    readonly location?: Reference<Location_2> | WithId<Location_2>;
+    readonly defaultValue?: readonly ScheduleCandidate[];
+    readonly onChange: (candidates: readonly ScheduleCandidate[]) => void;
+    readonly error?: string;
+    readonly disabled?: boolean;
+}
+
 export declare interface AppointmentDay {
     /** `YYYY-MM-DD` in the scheduling timezone. */
     readonly key: string;
@@ -39,6 +91,42 @@ export declare interface AppointmentDayTimesProps {
     readonly selected?: Appointment;
 }
 
+/**
+ * One option in an appointment pick list: what it is called, over what tells it
+ * apart from the others.
+ * @param props - The React props.
+ * @returns The row.
+ */
+export declare function AppointmentOptionRow(props: AppointmentOptionRowProps): JSX.Element;
+
+export declare interface AppointmentOptionRowProps {
+    readonly label: string;
+    /** What tells this option apart from one of the same name. Omitted when there is nothing on file. */
+    readonly detail?: string;
+}
+
+/**
+ * Chooses the service an appointment is for.
+ *
+ * Only services configured for scheduling are offered. A `HealthcareService`
+ * without a `SchedulingParameters` extension has no duration or alignment for
+ * `$find` to work from, so booking against it cannot succeed.
+ *
+ * @param props - The React props.
+ * @returns The service field.
+ */
+export declare function AppointmentServiceSelect(props: AppointmentServiceSelectProps): JSX.Element;
+
+export declare interface AppointmentServiceSelectProps {
+    readonly defaultValue?: WithId<HealthcareService>;
+    readonly onChange: (service: WithId<HealthcareService> | undefined) => void;
+    /** A chosen site, which narrows the services on offer to the ones held there. */
+    readonly location?: WithId<Location_2> | Reference<Location_2>;
+    readonly label?: string;
+    readonly error?: string;
+    readonly disabled?: boolean;
+}
+
 /** A calendar day's worth of available times, split by the actors offering them. */
 export declare interface AppointmentSlotGroup {
     /** Stable key derived from the actors, so React keys survive a refetch. */
@@ -65,6 +153,17 @@ export declare interface AppointmentSlotGroupCardProps {
     readonly disabled?: boolean;
 }
 
+/**
+ * Actor types whose schedules may be offered for booking.
+ *
+ * Does not include `PractitionerRole` to prevent double-booking
+ * a `Practitioner` who holds multiple roles. See `getSchedulingRole` for how
+ * `PractitionerRole` is still used to determine eligibility for a schedule.
+ */
+export declare const BOOKABLE_ACTOR_TYPES: readonly ["Practitioner", "Location", "Device"];
+
+export declare type BookableActorType = (typeof BOOKABLE_ACTOR_TYPES)[number];
+
 export declare function Calendar(props: CalendarProps): JSX.Element;
 
 export declare interface CalendarProps {
@@ -135,6 +234,25 @@ export declare function enumerateDateRange(range: DateRange, limit?: number): Da
  */
 export declare function filterByTimeOfDay(appointments: readonly Appointment[], timeOfDay: TimeOfDay, timezone?: string): Appointment[];
 
+/**
+ * Narrows candidates to the ones available at one location.
+ *
+ * A candidate that says nothing about where it is, or whose ancestry cannot be
+ * read, is kept: hiding something the caller may be entitled to book is worse
+ * than offering something at the wrong site.
+ *
+ * @param medplum - The Medplum client.
+ * @param candidates - Candidates to narrow.
+ * @param location - The site being booked at, or undefined to keep everything.
+ * @param options - Abort signal.
+ * @returns The candidates, minus the ones sited elsewhere.
+ */
+export declare function filterCandidatesByLocation(medplum: MedplumClient, candidates: readonly ScheduleCandidate[], location: Reference<Location_2> | WithId<Location_2> | undefined, options?: FilterCandidatesOptions): Promise<ScheduleCandidate[]>;
+
+export declare interface FilterCandidatesOptions {
+    readonly signal?: AbortSignal;
+}
+
 /**
  * Says in words which days a search covers.
  * @param range - The days asked for.
@@ -157,6 +275,18 @@ export declare function formatDayHeading(date: Date): string;
  */
 export declare function formatZonedTime(date: Date, timezone?: string): string;
 
+/**
+ * Builds the sets of actors an appointment could be held on.
+ *
+ * One combination is one `$find` request: the schedules within it are
+ * intersected, so its times are the times all of those actors are free.
+ *
+ * @param selections - What has been chosen.
+ * @returns One combination holding every chosen actor, in role order, or an
+ *   empty list when nothing is chosen.
+ */
+export declare function getActorCombinations(selections: ActorSelections): ActorCombination[];
+
 /**
  * Builds a key identifying the set of actors an appointment is offered by.
  * @param appointment - The proposed appointment.
@@ -193,6 +323,20 @@ export declare function getActorsKey(actors: readonly Reference[]): string;
  */
 export declare function getAppointmentKey(appointment: Appointment): string;
 
+/**
+ * Names a candidate's actor, for use in plain-text option lists.
+ * @param candidate - The candidate to name.
+ * @returns The name to show.
+ */
+export declare function getCandidateDisplay(candidate: ScheduleCandidate): string;
+
+/**
+ * Returns the role a candidate fills, from the type of its actor.
+ * @param candidate - The candidate to read.
+ * @returns The role, or undefined for an actor of a type nothing books against.
+ */
+export declare function getCandidateRole(candidate: ScheduleCandidate): SchedulingRole | undefined;
+
 /**
  * Returns an appointment's length in whole minutes.
  * @param appointment - The proposed appointment.
@@ -241,6 +385,20 @@ export declare function getNativeInputType(type: 'date' | 'time'): string;
  */
 export declare function getSchedulingRole(actorType: SchedulingActorType): SchedulingRole;
 
+/**
+ * Returns everything chosen, across roles.
+ * @param selections - What has been chosen.
+ * @returns The chosen candidates, in `SCHEDULING_ROLES` order.
+ */
+export declare function getSelectedCandidates(selections: ActorSelections): ScheduleCandidate[];
+
+/**
+ * Reports why the current selections cannot be searched, if they cannot.
+ * @param selections - What has been chosen.
+ * @returns A message to show the user, or undefined when the search can run.
+ */
+export declare function getSelectionError(selections: ActorSelections): string | undefined;
+
 /**
  * Groups proposed appointments into days, and each day into the sets of actors
  * offering those times.
@@ -251,6 +409,15 @@ export declare function getSchedulingRole(actorType: SchedulingActorType): Sched
  */
 export declare function groupAppointmentsByDay(appointments: readonly Appointment[], timezone?: string): AppointmentDay[];
 
+export declare function isBookableActorType(value: string | undefined): value is BookableActorType;
+
+/**
+ * Reports whether a role has to be filled.
+ * @param role - The role being filled.
+ * @returns Whether a search can run without it.
+ */
+export declare function isRoleRequired(role: SchedulingRole): boolean;
+
 /**
  * Returns whether two instants fall on the same local day.
  * @param left - The first instant.
@@ -304,6 +471,16 @@ export declare function ScheduleAvailabilityEditor(props: ScheduleAvailabilityEd
  */
 export declare type ScheduleAvailabilityEditorProps = ScheduleOverrideEditorProps | ServiceDefaultEditorProps;
 
+/**
+ * A Schedule that can be booked for a service, paired with the actor it belongs
+ * to.
+ */
+export declare interface ScheduleCandidate {
+    readonly schedule: WithId<Schedule>;
+    /** The actor itself, when the search was able to include it. */
+    readonly actorResource: WithId<Resource> | undefined;
+}
+
 /**
  * Props for editing the availability override a Schedule holds for one service.
  * @param schedule - The Schedule holding the availability override. Must have exactly one actor, as scheduling requires.
@@ -338,6 +515,32 @@ export declare type SchedulingActorType = (typeof SCHEDULING_ACTOR_TYPES)[number
 
 export declare type SchedulingRole = (typeof SCHEDULING_ROLES)[number];
 
+/**
+ * Finds the Schedules that can be booked for one role of a HealthcareService,
+ * narrowed to the actors whose name matches what was typed.
+ * @param medplum - The Medplum client.
+ * @param service - The HealthcareService being booked.
+ * @param options - The role, the text typed, the site, an abort signal, and a page size.
+ * @returns The matching schedules, each with its actor, by display name.
+ */
+export declare function searchScheduleCandidates(medplum: MedplumClient, service: WithId<HealthcareService>, options: SearchScheduleCandidatesOptions): Promise<ScheduleCandidate[]>;
+
+export declare interface SearchScheduleCandidatesOptions {
+    /** Which of the service's actors to offer. */
+    readonly role: SchedulingRole;
+    /** What the user typed. Empty offers whatever the role has, unfiltered by name. */
+    readonly query: string;
+    /**
+     * The site being booked at. Actors sited elsewhere are left out: a room or a
+     * device anywhere inside it counts, a provider only if one of their
+     * PractitionerRoles names it.
+     */
+    readonly location?: Reference<Location_2> | WithId<Location_2>;
+    readonly signal?: AbortSignal;
+    /** Maximum schedules to consider. Defaults to 25. */
+    readonly count?: number;
+}
+
 /**
  * Props for editing a service's own default hours, in place of any one calendar's override.
  * @param schedule - Omitted, which is what selects this mode.
@@ -375,4 +578,34 @@ export declare function setScheduleAvailability(schedule: Schedule, service: Wit
 
 export declare type TimeOfDay = 'any' | 'morning' | 'afternoon';
 
+/**
+ * Searches for the times an appointment could be held at.
+ * @param options - The service, actor combinations, days, and page size.
+ * @returns The times offered, plus load and error state.
+ */
+export declare function useProposedAppointments(options: UseProposedAppointmentsOptions): UseProposedAppointmentsResult;
+
+export declare interface UseProposedAppointmentsOptions {
+    /** The service being booked, as a reference or the resource itself. */
+    readonly service: Reference<HealthcareService> | WithId<HealthcareService> | undefined;
+    /** The sets of actors to search for, from `getActorCombinations`. */
+    readonly combinations: readonly ActorCombination[];
+    /** The days to search. Both ends are needed; `$find` refuses an open range. */
+    readonly range: DateRange;
+    /** Times to ask for per combination. Defaults to 20. */
+    readonly count?: number;
+}
+
+export declare interface UseProposedAppointmentsResult {
+    /**
+     * Every time offered, never persisted — `$find` proposes.
+     */
+    readonly appointments: readonly Appointment[];
+    /** How many `$find` requests the current combinations take. */
+    readonly requestCount: number;
+    readonly loading: boolean;
+    /** Set only when every combination failed. */
+    readonly error: Error | undefined;
+}
+
 export { }