@medplum/react 2.1.10 → 2.1.11

package/dist/types.d.ts

@@ -68,54 +68,54 @@ import { UserConfiguration } from '@medplum/fhirtypes';
 
 /**
  * Adds a filter for a date between two dates (inclusive of both dates).
- * @param definition The original search request.
- * @param field The field key name.
- * @param d1 The start date.
- * @param d2 The end date.
+ * @param definition - The original search request.
+ * @param field - The field key name.
+ * @param d1 - The start date.
+ * @param d2 - The end date.
  * @returns The updated search request.
  */
 export declare function addDateFilterBetween(definition: SearchRequest, field: string, d1: Date, d2: Date): SearchRequest;
 
 /**
  * Adds a field.
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addField(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter.
- * @param definition The original search request.
- * @param field The field key name.
- * @param op The operation key name.
- * @param value The filter value.
- * @param opt_clear Optional flag to clear filters on the field.
+ * @param definition - The original search request.
+ * @param field - The field key name.
+ * @param op - The operation key name.
+ * @param value - The filter value.
+ * @param opt_clear - Optional flag to clear filters on the field.
  * @returns The updated search request.
  */
 export declare function addFilter(definition: SearchRequest, field: string, op: Operator, value?: string, opt_clear?: boolean): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "last month".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addLastMonthFilter(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "missing".
- * @param definition The original search request.
- * @param field The field key name.
- * @param value Optional boolean value. Default is true.
+ * @param definition - The original search request.
+ * @param field - The field key name.
+ * @param value - Optional boolean value. Default is true.
  * @returns The updated search request.
  */
 export declare function addMissingFilter(definition: SearchRequest, field: string, value?: boolean): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "next month".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addNextMonthFilter(definition: SearchRequest, field: string): SearchRequest;
@@ -136,40 +136,40 @@ export declare interface AddressInputProps {
 
 /**
  * Adds a filter that constrains the specified field to "this month".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addThisMonthFilter(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "today".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addTodayFilter(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "tomorrow".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addTomorrowFilter(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to the year to date.
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addYearToDateFilter(definition: SearchRequest, field: string): SearchRequest;
 
 /**
  * Adds a filter that constrains the specified field to "yesterday".
- * @param definition The original search request.
- * @param field The field key name.
+ * @param definition - The original search request.
+ * @param field - The field key name.
  * @returns The updated search request.
  */
 export declare function addYesterdayFilter(definition: SearchRequest, field: string): SearchRequest;
@@ -276,11 +276,15 @@ export declare interface BackboneElementInputProps {
 
 /**
  * Returns a field display name.
- * @param key The field key.
+ * @param key - The field key.
  * @returns The field display name.
  */
 export declare function buildFieldNameString(key: string): string;
 
+export declare function buildInitialResponse(questionnaire: Questionnaire): QuestionnaireResponse;
+
+export declare function buildInitialResponseItem(item: QuestionnaireItem): QuestionnaireResponseItem;
+
 export declare function CalendarInput(props: CalendarInputProps): JSX.Element;
 
 export declare interface CalendarInputProps {
@@ -301,15 +305,15 @@ export declare interface CheckboxFormSectionProps {
 
 /**
  * Clears all of the filters.
- * @param definition The original search request.
+ * @param definition - The original search request.
  * @returns The updated search request.
  */
 export declare function clearFilters(definition: SearchRequest): SearchRequest;
 
 /**
  * Clears all of the filters on a certain field.
- * @param definition The original search request.
- * @param code The field key name to clear filters.
+ * @param definition - The original search request.
+ * @param code - The field key name to clear filters.
  * @returns The updated search request.
  */
 export declare function clearFiltersOnField(definition: SearchRequest, code: string): SearchRequest;
@@ -392,22 +396,22 @@ export declare function Container(props: ContainerProps): JSX.Element;
 
 /**
  * Converts an ISO-8601 date/time string to a local date/time string.
- * @param isoString The ISO-8601 date/time string to convert.
+ * @param isoString - The ISO-8601 date/time string to convert.
  * @returns The local date/time string.
  */
 export declare function convertIsoToLocal(isoString: string | undefined): string;
 
 /**
  * Converts a local date/time string to an ISO-8601 date/time string.
- * @param localString The local date/time string to convert.
+ * @param localString - The local date/time string to convert.
  * @returns The ISO-8601 date/time string.
  */
 export declare function convertLocalToIso(localString: string | undefined): string;
 
 /**
  * Dynamically creates a script tag for the specified JavaScript file.
- * @param src The JavaScript file URL.
- * @param onload Optional callback for the onload event.
+ * @param src - The JavaScript file URL.
+ * @param onload - Optional callback for the onload event.
  */
 export declare function createScriptTag(src: string, onload?: () => void): void;
 
@@ -416,7 +420,7 @@ export declare function createScriptTag(src: string, onload?: () => void): void;
  * The main purpose is to reconcile time zones.
  * Most of our date/time values are in ISO-8601, which includes a time zone offset.
  * The datetime-local input does not support the time zone offset.
- * @param props The Input props.
+ * @param props - The Input props.
  * @returns The JSX element to render.
  */
 export declare function DateTimeInput(props: DateTimeInputProps): JSX.Element;
@@ -439,8 +443,8 @@ export declare interface DefaultResourceTimelineProps {
 
 /**
  * Deletes a filter at the specified index.
- * @param definition The original search request.
- * @param index The filter index.
+ * @param definition - The original search request.
+ * @param index - The filter index.
  * @returns The updated search request.
  */
 export declare function deleteFilter(definition: SearchRequest, index: number): SearchRequest;
@@ -514,7 +518,7 @@ export declare interface ErrorBoundaryState {
 
 /**
  * The FhirPathTable component represents the embeddable search table control.
- * @param props FhirPathTable React props.
+ * @param props - FhirPathTable React props.
  * @returns FhirPathTable React node.
  */
 export declare function FhirPathTable(props: FhirPathTableProps): JSX.Element;
@@ -537,6 +541,8 @@ export declare interface FhirPathTableProps {
 
 export declare function Form(props: FormProps): JSX.Element;
 
+export declare function formatReferenceString(typedValue: TypedValue): string;
+
 export declare interface FormProps {
     onSubmit?: (formData: Record<string, string>) => void;
     style?: CSSProperties;
@@ -557,13 +563,34 @@ export declare interface FormSectionProps {
 
 export declare function getErrorsForInput(outcome: OperationOutcome | undefined, expression: string | undefined): string | undefined;
 
+/**
+ * Returns the collection of field definitions for the search request.
+ * @param search - The search request definition.
+ * @returns An array of field definitions.
+ */
+export declare function getFieldDefinitions(search: SearchRequest): SearchControlField[];
+
 export declare function getIssuesForExpression(outcome: OperationOutcome | undefined, expression: string | undefined): OperationOutcomeIssue[] | undefined;
 
 export declare function getNewMultiSelectValues(selected: string[], propertyName: string, item: QuestionnaireItem): QuestionnaireResponseItemAnswer[];
 
+/**
+ * Returns the number of pages in the questionnaire.
+ *
+ * By default, a questionnaire is represented as a simple single page questionnaire,
+ * so the default return value is 1.
+ *
+ * If the questionnaire has a page extension on the first item, then the number of pages
+ * is the number of top level items in the questionnaire.
+ *
+ * @param questionnaire - The questionnaire to get the number of pages for.
+ * @returns The number of pages in the questionnaire. Default is 1.
+ */
+export declare function getNumberOfPages(questionnaire: Questionnaire): number;
+
 /**
  * Returns a string representing the operation.
- * @param op The operation code.
+ * @param op - The operation code.
  * @returns A display string for the operation.
  */
 export declare function getOpString(op: Operator): string;
@@ -572,14 +599,14 @@ export declare function getQuestionnaireItemReferenceTargetTypes(item: Questionn
 
 /**
  * Starts a request to generate a recapcha token.
- * @param siteKey The reCAPTCHA site key, available from the reCAPTCHA admin page.
+ * @param siteKey - The reCAPTCHA site key, available from the reCAPTCHA admin page.
  * @returns Promise to a recaptcha token for the current user.
  */
 export declare function getRecaptcha(siteKey: string): Promise<string>;
 
 /**
  * Returns a list of operators for a search parameter.
- * @param searchParam The search parameter.
+ * @param searchParam - The search parameter.
  * @returns The list of operators that can be used for the search parameter.
  */
 export declare function getSearchOperators(searchParam: SearchParameter): Operator[] | undefined;
@@ -588,7 +615,7 @@ export declare function getSortField(definition: SearchRequest): string | undefi
 
 export declare function Header(props: HeaderProps): JSX.Element;
 
-declare interface HeaderProps {
+export declare interface HeaderProps {
     pathname?: string;
     searchParams?: URLSearchParams;
     headerSearchDisabled?: boolean;
@@ -629,11 +656,11 @@ export declare interface IdentifierInputProps {
 /**
  * Dynamically loads the recaptcha script.
  * We do not want to load the script on page load unless the user needs it.
- * @param siteKey The reCAPTCHA site key, available from the reCAPTCHA admin page.
+ * @param siteKey - The reCAPTCHA site key, available from the reCAPTCHA admin page.
  */
 export declare function initRecaptcha(siteKey: string): void;
 
-declare type IntervalGroup = {
+export declare type IntervalGroup = {
     id: string;
     filters: Record<string, any>;
     intervals: ObservationDefinitionQualifiedInterval[];
@@ -677,7 +704,7 @@ export declare interface MedplumLinkProps extends TextProps {
  * Medplum context includes:
  *   1) medplum - Medplum client library
  *   2) profile - The current user profile (if signed in)
- * @param props The MedplumProvider React props.
+ * @param props - The MedplumProvider React props.
  * @returns The MedplumProvider React node.
  */
 export declare function MedplumProvider(props: MedplumProviderProps): JSX.Element;
@@ -761,7 +788,7 @@ export declare interface PanelStylesParams {
 
 /**
  * Parses an HTML form and returns the result as a JavaScript object.
- * @param form The HTML form element.
+ * @param form - The HTML form element.
  * @returns Form values in key value pairs.
  */
 export declare function parseForm(form: HTMLFormElement): Record<string, string>;
@@ -832,16 +859,6 @@ export declare enum QuestionnaireItemType {
     quantity = "quantity"
 }
 
-export declare function QuestionnaireRepeatWrapper(props: QuestionnaireRepeatWrapperProps): JSX.Element;
-
-export declare interface QuestionnaireRepeatWrapperProps {
-    item: QuestionnaireItem;
-    allResponses: QuestionnaireResponseItem[];
-    currentResponseItems: QuestionnaireResponseItem[];
-    groupSequence?: number;
-    onChange: (newResponseItem: QuestionnaireResponseItem, index?: number) => void;
-}
-
 export declare function RangeDisplay(props: RangeDisplayProps): JSX.Element | null;
 
 export declare interface RangeDisplayProps {
@@ -851,7 +868,7 @@ export declare interface RangeDisplayProps {
 /**
  * Renders a Range input.
  * See: https://www.hl7.org/fhir/datatypes.html#Range
- * @param props Range input properties.
+ * @param props - Range input properties.
  * @returns Range input element.
  */
 export declare function RangeInput(props: RangeInputProps): JSX.Element;
@@ -919,8 +936,8 @@ export declare interface RegisterFormProps {
 
 /**
  * Returns a fragment to be displayed in the search table for the value.
- * @param resource The parent resource.
- * @param field The search code or FHIRPath expression.
+ * @param resource - The parent resource.
+ * @param field - The search code or FHIRPath expression.
  * @returns The fragment to display.
  */
 export declare function renderValue(resource: Resource, field: SearchControlField): string | JSX.Element | null | undefined;
@@ -935,7 +952,7 @@ export declare interface RequestGroupDisplayProps {
 
 export declare function ResourceArrayDisplay(props: ResourceArrayDisplayProps): JSX.Element;
 
-declare interface ResourceArrayDisplayProps {
+export declare interface ResourceArrayDisplayProps {
     property: InternalSchemaElement;
     values: any[];
     arrayElement?: boolean;
@@ -945,7 +962,7 @@ declare interface ResourceArrayDisplayProps {
 
 export declare function ResourceArrayInput(props: ResourceArrayInputProps): JSX.Element;
 
-declare interface ResourceArrayInputProps {
+export declare interface ResourceArrayInputProps {
     property: InternalSchemaElement;
     name: string;
     defaultValue?: any[];
@@ -1021,7 +1038,7 @@ export declare interface ResourceNameProps extends TextProps {
 
 /**
  * Low-level component that renders a property from a given resource, given type information.
- * @param props The ResourcePropertyDisplay React props.
+ * @param props - The ResourcePropertyDisplay React props.
  * @returns The ResourcePropertyDisplay React node.
  */
 export declare function ResourcePropertyDisplay(props: ResourcePropertyDisplayProps): JSX.Element;
@@ -1099,7 +1116,7 @@ export declare class SearchClickEvent extends Event {
  * The SearchControl component represents the embeddable search table control.
  * It includes the table, rows, headers, sorting, etc.
  * It does not include the field editor, filter editor, pagination buttons.
- * @param props The SearchControl React props.
+ * @param props - The SearchControl React props.
  * @returns The SearchControl React node.
  */
 export declare function SearchControl(props: SearchControlProps): JSX.Element;
@@ -1131,7 +1148,7 @@ export declare function SearchControl(props: SearchControlProps): JSX.Element;
  * Overall, we want columns, fields, properties, and search parameters to feel seamless,
  * so we try our darndest to make this work.
  */
-declare interface SearchControlField {
+export declare interface SearchControlField {
     readonly name: string;
     readonly elementDefinition?: InternalSchemaElement;
     readonly searchParams?: SearchParameter[];
@@ -1158,7 +1175,7 @@ export declare interface SearchControlProps {
 
 export declare function SearchFieldEditor(props: SearchFieldEditorProps): JSX.Element | null;
 
-declare interface SearchFieldEditorProps {
+export declare interface SearchFieldEditorProps {
     visible: boolean;
     search: SearchRequest;
     onOk: (search: SearchRequest) => void;
@@ -1187,24 +1204,24 @@ export declare interface ServiceRequestTimelineProps {
 
 /**
  * Sets the array of filters.
- * @param definition The original search request.
- * @param filters The new filters.
+ * @param definition - The original search request.
+ * @param filters - The new filters.
  * @returns The updated search request.
  */
 export declare function setFilters(definition: SearchRequest, filters: Filter[]): SearchRequest;
 
 /**
  * Sets the offset (starting at zero).
- * @param definition The original search request.
- * @param offset The offset number.
+ * @param definition - The original search request.
+ * @param offset - The offset number.
  * @returns The updated search request.
  */
 export declare function setOffset(definition: SearchRequest, offset: number): SearchRequest;
 
 /**
  * Creates a new search request with the search offset at the specified page.
- * @param definition The search definition.
- * @param page The new page number
+ * @param definition - The search definition.
+ * @param page - The new page number
  * @returns The new search definition.
  */
 export declare function setPage(definition: SearchRequest, page: number): SearchRequest;
@@ -1214,9 +1231,9 @@ export declare function setQuestionnaireItemReferenceTargetTypes(item: Questionn
 /**
  * Sorts the search by the specified key, and optional direction.
  * Direction defaults to ascending ('asc') if not specified.
- * @param definition The original search request.
- * @param sort The sort key.
- * @param desc Optional descending flag. Default is false.
+ * @param definition - The original search request.
+ * @param sort - The sort key.
+ * @param desc - Optional descending flag. Default is false.
  * @returns The updated search request.
  */
 export declare function setSort(definition: SearchRequest, sort: string, desc?: boolean): SearchRequest;
@@ -1230,7 +1247,7 @@ export declare function setSort(definition: SearchRequest, sort: string, desc?:
  * 3) Choose profile - If the user has multiple profiles, prompt to choose one
  * 4) Choose scope - If the user has multiple scopes, prompt to choose one
  * 5) Success - Return to the caller with either a code or a redirect
- * @param props The SignInForm React props.
+ * @param props - The SignInForm React props.
  * @returns The SignInForm React node.
  */
 export declare function SignInForm(props: SignInFormProps): JSX.Element;
@@ -1255,8 +1272,8 @@ export declare interface SmartSearchResponse {
 
 /**
  * Sorts an array of resources in place by meta.lastUpdated ascending.
- * @param resources Array of resources.
- * @param timelineResource Optional primary resource of a timeline view. If specified, the primary resource will be sorted by meta.lastUpdated descending.
+ * @param resources - Array of resources.
+ * @param timelineResource - Optional primary resource of a timeline view. If specified, the primary resource will be sorted by meta.lastUpdated descending.
  */
 export declare function sortByDateAndPriority(resources: Resource[], timelineResource?: Resource): void;
 
@@ -1294,8 +1311,8 @@ export declare interface TimingInputProps {
  * Toggles the sort of the search by key.
  * If the search is already sorted by the key, reverses the direction.
  * If the search is not sorted by the key, sort in ascending order.
- * @param definition The original search request.
- * @param key The field key name.
+ * @param definition - The original search request.
+ * @param key - The field key name.
  * @returns The updated search request.
  */
 export declare function toggleSort(definition: SearchRequest, key: string): SearchRequest;
@@ -1329,8 +1346,8 @@ export declare function useMedplumProfile(): ProfileResource | undefined;
 /**
  * React Hook to use a FHIR reference.
  * Handles the complexity of resolving references and caching resources.
- * @param value The resource or reference to resource.
- * @param setOutcome Optional callback to set the OperationOutcome.
+ * @param value - The resource or reference to resource.
+ * @param setOutcome - Optional callback to set the OperationOutcome.
  * @returns The resolved resource.
  */
 export declare function useResource<T extends Resource>(value: Reference<T> | T | undefined, setOutcome?: (outcome: OperationOutcome) => void): T | undefined;
@@ -1340,8 +1357,8 @@ export declare function useResource<T extends Resource>(value: Reference<T> | T
  *
  * This is a convenience hook for calling the MedplumClient.search() method.
  *
- * @param resourceType The FHIR resource type to search.
- * @param query Optional search parameters.
+ * @param resourceType - The FHIR resource type to search.
+ * @param query - Optional search parameters.
  * @returns A 3-element tuple containing the search result, loading flag, and operation outcome.
  */
 export declare function useSearch<K extends ResourceType>(resourceType: K, query?: QueryTypes): [Bundle<ExtractResource<K>> | undefined, boolean, OperationOutcome | undefined];
@@ -1351,8 +1368,8 @@ export declare function useSearch<K extends ResourceType>(resourceType: K, query
  *
  * This is a convenience hook for calling the MedplumClient.searchOne() method.
  *
- * @param resourceType The FHIR resource type to search.
- * @param query Optional search parameters.
+ * @param resourceType - The FHIR resource type to search.
+ * @param query - Optional search parameters.
  * @returns A 3-element tuple containing the search result, loading flag, and operation outcome.
  */
 export declare function useSearchOne<K extends ResourceType>(resourceType: K, query?: QueryTypes): [ExtractResource<K> | undefined, boolean, OperationOutcome | undefined];
@@ -1362,8 +1379,8 @@ export declare function useSearchOne<K extends ResourceType>(resourceType: K, qu
  *
  * This is a convenience hook for calling the MedplumClient.searchResources() method.
  *
- * @param resourceType The FHIR resource type to search.
- * @param query Optional search parameters.
+ * @param resourceType - The FHIR resource type to search.
+ * @param query - Optional search parameters.
  * @returns A 3-element tuple containing the search result, loading flag, and operation outcome.
  */
 export declare function useSearchResources<K extends ResourceType>(resourceType: K, query?: QueryTypes): [ResourceArray<ExtractResource<K>> | undefined, boolean, OperationOutcome | undefined];

package/package.json

@@ -1,24 +1,50 @@
 {
   "name": "@medplum/react",
-  "version": "2.1.10",
+  "version": "2.1.11",
   "description": "Medplum React Component Library",
-  "author": "Medplum <hello@medplum.com>",
-  "license": "Apache-2.0",
+  "keywords": [
+    "medplum",
+    "fhir",
+    "healthcare",
+    "interoperability",
+    "json",
+    "serialization",
+    "hl7",
+    "standards",
+    "clinical",
+    "dstu2",
+    "stu3",
+    "r4",
+    "normative",
+    "ui",
+    "input",
+    "react",
+    "react-component"
+  ],
   "homepage": "https://www.medplum.com/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/medplum/medplum.git",
+    "url": "git+https://github.com/medplum/medplum.git",
     "directory": "packages/react"
   },
-  "engines": {
-    "node": ">=18.0.0"
+  "license": "Apache-2.0",
+  "author": "Medplum <hello@medplum.com>",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    "types": "./dist/types.d.ts",
+    "require": "./dist/cjs/index.cjs",
+    "import": "./dist/esm/index.mjs"
   },
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types.d.ts",
   "scripts": {
+    "build": "npm run clean && tsc --project tsconfig.build.json && node esbuild.mjs && api-extractor run --local",
     "clean": "rimraf dist storybook-static",
     "dev": "storybook dev -p 6006",
-    "build": "npm run clean && tsc --project tsconfig.build.json && node esbuild.mjs && api-extractor run --local",
-    "test": "jest",
-    "storybook": "storybook build"
+    "storybook": "storybook build",
+    "test": "jest"
   },
   "devDependencies": {
     "@emotion/react": "11.11.1",
@@ -76,32 +102,7 @@
       "optional": true
     }
   },
-  "main": "dist/cjs/index.cjs",
-  "module": "dist/esm/index.mjs",
-  "types": "dist/types.d.ts",
-  "exports": {
-    "types": "./dist/types.d.ts",
-    "require": "./dist/cjs/index.cjs",
-    "import": "./dist/esm/index.mjs"
-  },
-  "sideEffects": false,
-  "keywords": [
-    "medplum",
-    "fhir",
-    "healthcare",
-    "interoperability",
-    "json",
-    "serialization",
-    "hl7",
-    "standards",
-    "clinical",
-    "dstu2",
-    "stu3",
-    "r4",
-    "normative",
-    "ui",
-    "input",
-    "react",
-    "react-component"
-  ]
+  "engines": {
+    "node": ">=18.0.0"
+  }
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../tsdoc.json"]
+}