@medplum/react 2.0.21 → 2.0.22

package/dist/types/SearchControl/SearchUtils.d.ts

@@ -4,123 +4,144 @@ import { Resource, SearchParameter } from '@medplum/fhirtypes';
 import { SearchControlField } from './SearchControlField';
 /**
  * Sets the array of filters.
- *
- * @param {Array} 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;
 /**
  * Clears all of the filters.
+ * @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 {string} 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;
 /**
  * Adds a filter.
- *
- * @param {string} field The field key name.
- * @param {Operator} op The operation key name.
- * @param {?string} value The filter value.
- * @param {boolean=} 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 field.
- *
- * @param {string} 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;
 /**
  * Deletes a filter at the specified index.
- *
- * @param {number} 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;
 /**
  * Adds a filter that constrains the specified field to "yesterday".
- *
- * @param {string} 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;
 /**
  * Adds a filter that constrains the specified field to "today".
- *
- * @param {string} 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 {string} 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 "last month".
- *
- * @param {string} 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 "this month".
- *
- * @param {string} 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 "next month".
- *
- * @param {string} 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;
 /**
  * Adds a filter that constrains the specified field to the year to date.
- *
- * @param {string} 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 for a date between two dates (inclusive of both dates).
- *
- * @param {string} field The field key name.
- * @param {Date} d1 The start date.
- * @param {Date} 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 filter that constrains the specified field to "missing".
- *
- * @param {string} field The field key name.
+ * @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;
 /**
  * Sets the offset (starting at zero).
- *
- * @param {number} 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
- * @return The new search definition.
+ * @returns The new search definition.
  */
 export declare function setPage(definition: SearchRequest, page: number): SearchRequest;
 /**
  * Sorts the search by the specified key, and optional direction.
  * Direction defaults to ascending ('asc') if not specified.
- *
- * @param {string} sortField The sort key.
+ * @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;
 /**
  * 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 {string} 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;
 export declare function getSortField(definition: SearchRequest): string | undefined;
@@ -133,9 +154,8 @@ export declare function isSortDescending(definition: SearchRequest): boolean;
 export declare function getSearchOperators(searchParam: SearchParameter): Operator[] | undefined;
 /**
  * Returns a string representing the operation.
- *
- * @param {string} op The operation code.
- * @return {string} A display string for the operation.
+ * @param op The operation code.
+ * @returns A display string for the operation.
  */
 export declare function getOpString(op: Operator): string;
 /**
@@ -147,7 +167,7 @@ export declare function buildFieldNameString(key: string): string;
 /**
  * Returns a fragment to be displayed in the search table for the value.
  * @param resource The parent resource.
- * @param key The search code or FHIRPath expression.
+ * @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;

package/dist/types/ValueSetAutocomplete/ValueSetAutocomplete.d.ts

@@ -8,5 +8,8 @@ export interface ValueSetAutocompleteProps extends Omit<AsyncAutocompleteProps<V
 }
 /**
  * A low-level component to autocomplete based on a FHIR Valueset.
+ * This is the base component for CodeableConceptInput, CodingInput, and CodeInput.
+ * @param props The ValueSetAutocomplete React props.
+ * @returns The ValueSetAutocomplete React node.
  */
 export declare function ValueSetAutocomplete(props: ValueSetAutocompleteProps): JSX.Element;

package/dist/types/auth/SignInForm.d.ts

@@ -19,5 +19,7 @@ export interface SignInFormProps extends BaseLoginRequest {
  * 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.
+ * @returns The SignInForm React node.
  */
 export declare function SignInForm(props: SignInFormProps): JSX.Element;

package/dist/types/useResource/useResource.d.ts

@@ -3,6 +3,7 @@ import { OperationOutcome, Reference, Resource } from '@medplum/fhirtypes';
  * 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.
  * @returns The resolved resource.
  */
 export declare function useResource<T extends Resource>(value: Reference<T> | T | undefined, setOutcome?: (outcome: OperationOutcome) => void): T | undefined;

package/dist/types/utils/script.d.ts

@@ -1,5 +1,6 @@
 /**
  * Dynamically creates a script tag for the specified JavaScript file.
  * @param src The JavaScript file URL.
+ * @param onload Optional callback for the onload event.
  */
 export declare function createScriptTag(src: string, onload?: () => void): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/react",
-  "version": "2.0.21",
+  "version": "2.0.22",
   "description": "Medplum React Component Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",
@@ -26,19 +26,19 @@
     "@medplum/definitions": "*",
     "@medplum/fhirtypes": "*",
     "@medplum/mock": "*",
-    "@storybook/addon-actions": "7.0.12",
-    "@storybook/addon-essentials": "7.0.12",
-    "@storybook/addon-links": "7.0.12",
-    "@storybook/react": "7.0.12",
-    "@storybook/react-webpack5": "7.0.12",
+    "@storybook/addon-actions": "7.0.18",
+    "@storybook/addon-essentials": "7.0.18",
+    "@storybook/addon-links": "7.0.18",
+    "@storybook/react": "7.0.18",
+    "@storybook/react-webpack5": "7.0.18",
     "@svgr/rollup": "8.0.1",
-    "@tabler/icons-react": "2.19.0",
+    "@tabler/icons-react": "2.22.0",
     "@testing-library/dom": "9.3.0",
     "@testing-library/jest-dom": "5.16.5",
     "@testing-library/react": "14.0.0",
-    "@types/jest": "29.5.1",
-    "@types/node": "20.2.1",
-    "@types/react": "18.2.6",
+    "@types/jest": "29.5.2",
+    "@types/node": "20.2.5",
+    "@types/react": "18.2.8",
     "@types/react-dom": "18.2.4",
     "dotenv-webpack": "8.0.1",
     "html-webpack-plugin": "5.5.1",
@@ -48,8 +48,8 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "rimraf": "5.0.1",
-    "storybook": "7.0.12",
-    "typescript": "5.0.4"
+    "storybook": "7.0.18",
+    "typescript": "5.1.3"
   },
   "peerDependencies": {
     "@emotion/react": "^11.10.4",