@openmrs/esm-react-utils 6.3.1-pre.3105 → 6.3.1-pre.3106

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 52 files with swc (131.05ms)
+[0] Successfully compiled: 52 files with swc (175.49ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/ComponentContext.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { type ComponentConfig } from '@openmrs/esm-extensions';
 /**
  * Available to all components. Provided by `openmrsComponentDecorator`.

package/dist/ConfigurableLink.d.ts

@@ -5,14 +5,17 @@ import { type TemplateParams } from '@openmrs/esm-navigation';
  * @noInheritDoc
  */
 export interface ConfigurableLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
-    /** The target path or URL. Supports interpolation. See [[navigate]] */
     to: string;
-    /** A dictionary of values to interpolate into the URL, in addition to the default keys `openmrsBase` and `openmrsSpaBase`. */
     templateParams?: TemplateParams;
-    /** A callback to be called just before navigation occurs */
     onBeforeNavigate?: (event: MouseEvent) => void;
 }
 /**
  * A React link component which calls [[navigate]] when clicked
+ *
+ * @param to The target path or URL. Supports interpolation. See [[navigate]]
+ * @param templateParams: A dictionary of values to interpolate into the URL, in addition to the default keys `openmrsBase` and `openmrsSpaBase`.
+ * @param onBeforeNavigate A callback to be called just before navigation occurs
+ * @param children Inline elements within the link
+ * @param otherProps Any other valid props for an <a> tag except `href` and `onClick`
  */
 export declare function ConfigurableLink({ to, templateParams, onBeforeNavigate, children, ...otherProps }: PropsWithChildren<ConfigurableLinkProps>): React.JSX.Element;

package/dist/ConfigurableLink.js

@@ -25,6 +25,12 @@ function handleClick(event, to, templateParams, onBeforeNavigate) {
 }
 /**
  * A React link component which calls [[navigate]] when clicked
+ *
+ * @param to The target path or URL. Supports interpolation. See [[navigate]]
+ * @param templateParams: A dictionary of values to interpolate into the URL, in addition to the default keys `openmrsBase` and `openmrsSpaBase`.
+ * @param onBeforeNavigate A callback to be called just before navigation occurs
+ * @param children Inline elements within the link
+ * @param otherProps Any other valid props for an <a> tag except `href` and `onClick`
  */ export function ConfigurableLink({ to, templateParams, onBeforeNavigate, children, ...otherProps }) {
     useEffect(()=>{
         if (otherProps.href) {

package/dist/ExtensionSlot.d.ts

@@ -2,34 +2,44 @@
 import React from 'react';
 import { type AssignedExtension } from '@openmrs/esm-extensions';
 export interface ExtensionSlotBaseProps {
-    /** The name of the extension slot */
     name: string;
-    /**
-     * The name of the extension slot
-     * @deprecated Use `name`
-     */
+    /** @deprecated Use `name` */
     extensionSlotName?: string;
-    /**
-     * An optional function for filtering or otherwise modifying
-     *   the list of extensions that will be rendered.
-     */
     select?: (extensions: Array<AssignedExtension>) => Array<AssignedExtension>;
-    /**
-     *Only works if no children are provided*. Passes data
-     *   through as props to the extensions that are mounted here. If `ExtensionSlot`
-     *   has children, you must pass the state through the `state` param of the
-     *   `Extension` component.
-     */
-    state?: Record<string | number | symbol, unknown>;
+    state?: Record<string, unknown>;
 }
-export interface ExtensionSlotProps extends ExtensionSlotBaseProps, Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
-    children?: React.ReactNode | ((extension: AssignedExtension, state?: Record<string, unknown>) => React.ReactNode);
+export interface OldExtensionSlotBaseProps {
+    name?: string;
+    /** @deprecated Use `name` */
+    extensionSlotName: string;
+    select?: (extensions: Array<AssignedExtension>) => Array<AssignedExtension>;
+    state?: Record<string, unknown>;
 }
+export type ExtensionSlotProps = (OldExtensionSlotBaseProps | ExtensionSlotBaseProps) & Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> & {
+    children?: React.ReactNode | ((extension: AssignedExtension, state?: Record<string, unknown>) => React.ReactNode);
+};
 /**
  * An [extension slot](https://o3-docs.openmrs.org/docs/extension-system).
  * A place with a name. Extensions that get connected to that name
  * will be rendered into this.
  *
+ * @param props.name The name of the extension slot
+ * @param props.select An optional function for filtering or otherwise modifying
+ *   the list of extensions that will be rendered.
+ * @param props.state *Only works if no children are provided*. Passes data
+ *   through as props to the extensions that are mounted here. If `ExtensionSlot`
+ *   has children, you must pass the state through the `state` param of the
+ *   `Extension` component.
+ * @param props.children There are two different ways to use `ExtensionSlot`
+ *   children.
+ *  - Passing a `ReactNode`, the "normal" way. The child must contain the component
+ *     `Extension`. Whatever is passed as the child will be rendered once per extension.
+ *     See the first example below.
+ *  - Passing a function, the "render props" way. The child must be a function
+ *     which takes a [[ConnectedExtension]] as argument and returns a `ReactNode`.
+ *     the resulting react node must contain the component `Extension`. It will
+ *     be run for each extension. See the second example below.
+ *
  * @example
  * Passing a react node as children
  *

package/dist/ExtensionSlot.js

@@ -10,6 +10,23 @@ function defaultSelect(extensions) {
  * A place with a name. Extensions that get connected to that name
  * will be rendered into this.
  *
+ * @param props.name The name of the extension slot
+ * @param props.select An optional function for filtering or otherwise modifying
+ *   the list of extensions that will be rendered.
+ * @param props.state *Only works if no children are provided*. Passes data
+ *   through as props to the extensions that are mounted here. If `ExtensionSlot`
+ *   has children, you must pass the state through the `state` param of the
+ *   `Extension` component.
+ * @param props.children There are two different ways to use `ExtensionSlot`
+ *   children.
+ *  - Passing a `ReactNode`, the "normal" way. The child must contain the component
+ *     `Extension`. Whatever is passed as the child will be rendered once per extension.
+ *     See the first example below.
+ *  - Passing a function, the "render props" way. The child must be a function
+ *     which takes a [[ConnectedExtension]] as argument and returns a `ReactNode`.
+ *     the resulting react node must contain the component `Extension`. It will
+ *     be run for each extension. See the second example below.
+ *
  * @example
  * Passing a react node as children
  *

package/dist/useAttachments.d.ts

@@ -4,7 +4,7 @@ export declare function useAttachments(patientUuid: string, includeEncounterless
     isLoading: boolean;
     data: AttachmentResponse[];
     error: any;
-    mutate: import("swr").KeyedMutator<FetchResponse<{
+    mutate: import("swr/dist/_internal").KeyedMutator<FetchResponse<{
         results: Array<AttachmentResponse>;
     }>>;
     isValidating: boolean;

package/dist/useEmrConfiguration.d.ts

@@ -91,7 +91,7 @@ export interface EmrApiConfigurationResponse {
 export declare function useEmrConfiguration(): {
     emrConfiguration: EmrApiConfigurationResponse | undefined;
     isLoadingEmrConfiguration: boolean;
-    mutateEmrConfiguration: import("swr").KeyedMutator<FetchResponse<EmrApiConfigurationResponse>>;
+    mutateEmrConfiguration: import("swr/dist/_internal").KeyedMutator<FetchResponse<EmrApiConfigurationResponse>>;
     errorFetchingEmrConfiguration: Error | undefined;
 };
 export {};

package/dist/useExtensionInternalStore.d.ts

@@ -5,5 +5,5 @@ import type { ExtensionInternalStore } from '@openmrs/esm-extensions';
 export declare const useExtensionInternalStore: {
     (): ExtensionInternalStore;
     <A extends import("./useStore").Actions<ExtensionInternalStore>>(actions: A): ExtensionInternalStore & import("./useStore").BoundActions<ExtensionInternalStore, A>;
-    <A extends import("./useStore").Actions<ExtensionInternalStore>>(actions?: A | undefined): ExtensionInternalStore & import("./useStore").BoundActions<ExtensionInternalStore, A>;
+    <A_1 extends import("./useStore").Actions<ExtensionInternalStore>>(actions?: A_1 | undefined): ExtensionInternalStore & import("./useStore").BoundActions<ExtensionInternalStore, A_1>;
 };

package/dist/useExtensionStore.d.ts

@@ -3,5 +3,5 @@ import { type ExtensionStore } from '@openmrs/esm-extensions';
 export declare const useExtensionStore: {
     (): ExtensionStore;
     <A extends import("./useStore").Actions<ExtensionStore>>(actions: A): ExtensionStore & import("./useStore").BoundActions<ExtensionStore, A>;
-    <A extends import("./useStore").Actions<ExtensionStore>>(actions?: A | undefined): ExtensionStore & import("./useStore").BoundActions<ExtensionStore, A>;
+    <A_1 extends import("./useStore").Actions<ExtensionStore>>(actions?: A_1 | undefined): ExtensionStore & import("./useStore").BoundActions<ExtensionStore, A_1>;
 };

package/dist/useFhirFetchAll.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="fhir" />
 import { type UseServerInfiniteReturnObject } from './useOpenmrsInfinite';
 import { type UseServerFetchAllOptions } from './useOpenmrsFetchAll';
 /**

package/dist/useFhirInfinite.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="fhir" />
 import { type UseServerInfiniteOptions, type UseServerInfiniteReturnObject } from './useOpenmrsInfinite';
 /**
  * Fhir REST endpoints that return a list of objects, are server-side paginated.

package/dist/useFhirPagination.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="fhir" />
+/// <reference types="react" />
 /** @module @category UI */
 import { type FetchResponse } from '@openmrs/esm-api';
 import { type ServerPaginationHandlers, type UseServerPaginationOptions } from './useOpenmrsPagination';
@@ -21,7 +23,7 @@ import { type ServerPaginationHandlers, type UseServerPaginationOptions } from '
  */
 export declare function useFhirPagination<T extends fhir.ResourceBase>(url: string | URL, pageSize: number, options?: UseServerPaginationOptions<fhir.Bundle>): {
     error: any;
-    mutate: import("swr").KeyedMutator<FetchResponse<fhir.Bundle>>;
+    mutate: import("swr/dist/_internal").KeyedMutator<FetchResponse<fhir.Bundle>>;
     isValidating: boolean;
     isLoading: boolean;
     data: T[] | undefined;

package/dist/useLayoutType.d.ts

@@ -1,3 +1,3 @@
 export type LayoutType = 'phone' | 'tablet' | 'small-desktop' | 'large-desktop';
 export declare function useLayoutType(): LayoutType;
-export declare const isDesktop: (layout: LayoutType) => layout is "small-desktop" | "large-desktop";
+export declare const isDesktop: (layout: LayoutType) => boolean;

package/dist/useOnClickOutside.d.ts

@@ -1 +1,2 @@
+/// <reference types="react" />
 export declare function useOnClickOutside<T extends HTMLElement = HTMLElement>(handler: (event: MouseEvent) => void, active?: boolean): import("react").RefObject<T>;

package/dist/useOpenmrsPagination.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 /** @module @category UI */
 import { type FetchResponse } from '@openmrs/esm-api';
 import { type SWRConfiguration } from 'swr';
@@ -54,7 +55,7 @@ export interface UseServerPaginationOptions<R> {
  */
 export declare function useOpenmrsPagination<T>(url: string | URL, pageSize: number, options?: UseServerPaginationOptions<OpenMRSPaginatedResponse<T>>): {
     error: any;
-    mutate: import("swr").KeyedMutator<FetchResponse<OpenMRSPaginatedResponse<T>>>;
+    mutate: import("swr/dist/_internal").KeyedMutator<FetchResponse<OpenMRSPaginatedResponse<T>>>;
     isValidating: boolean;
     isLoading: boolean;
     data: T[] | undefined;
@@ -80,7 +81,7 @@ export interface ServerPaginationHandlers<T, R> {
 }
 export declare function useServerPagination<T, R>(url: string | URL, pageSize: number, serverPaginationHandlers: ServerPaginationHandlers<T, R>, options?: UseServerPaginationOptions<R>): {
     error: any;
-    mutate: import("swr").KeyedMutator<FetchResponse<R>>;
+    mutate: import("swr/dist/_internal").KeyedMutator<FetchResponse<R>>;
     isValidating: boolean;
     isLoading: boolean;
     data: T[] | undefined;

package/dist/useOpenmrsSWR.d.ts

@@ -47,4 +47,4 @@ export type UseOpenmrsSWROptions = {
  * @param options An object of optional parameters to provide, including a {@link FetchConfig} object
  *   to pass to {@link openmrsFetch} or options to pass to SWR
  */
-export declare function useOpenmrsSWR<DataType = any, ErrorType = any>(key: Key, options?: UseOpenmrsSWROptions): import("swr").SWRResponse<FetchResponse<DataType>, ErrorType, SWRConfiguration<FetchResponse<DataType>, ErrorType, import("swr").BareFetcher<FetchResponse<DataType>>> | undefined>;
+export declare function useOpenmrsSWR<DataType = any, ErrorType = any>(key: Key, options?: UseOpenmrsSWROptions): import("swr/dist/_internal").SWRResponse<FetchResponse<DataType>, ErrorType, SWRConfiguration<FetchResponse<DataType>, ErrorType, import("swr/dist/_internal").BareFetcher<FetchResponse<DataType>>> | undefined>;

package/dist/usePatient.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="fhir" />
 export type NullablePatient = fhir.Patient | null;
 /**
  * This React hook returns a patient object. If the `patientUuid` is provided

package/dist/useStore.d.ts

@@ -25,6 +25,6 @@ declare function useStoreWithActions<T, A extends Actions<T>>(store: StoreApi<T>
 declare function createUseStore<T>(store: StoreApi<T>): {
     (): T;
     <A extends Actions<T>>(actions: A): T & BoundActions<T, A>;
-    <A extends Actions<T>>(actions?: A): T & BoundActions<T, A>;
+    <A_1 extends Actions<T>>(actions?: A_1 | undefined): T & BoundActions<T, A_1>;
 };
 export { createUseStore, useStore, useStoreWithActions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "6.3.1-pre.3105",
+  "version": "6.3.1-pre.3106",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "type": "module",
@@ -78,17 +78,17 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "6.3.1-pre.3105",
-    "@openmrs/esm-config": "6.3.1-pre.3105",
-    "@openmrs/esm-context": "6.3.1-pre.3105",
-    "@openmrs/esm-emr-api": "6.3.1-pre.3105",
-    "@openmrs/esm-error-handling": "6.3.1-pre.3105",
-    "@openmrs/esm-extensions": "6.3.1-pre.3105",
-    "@openmrs/esm-feature-flags": "6.3.1-pre.3105",
-    "@openmrs/esm-globals": "6.3.1-pre.3105",
-    "@openmrs/esm-navigation": "6.3.1-pre.3105",
-    "@openmrs/esm-state": "6.3.1-pre.3105",
-    "@openmrs/esm-utils": "6.3.1-pre.3105",
+    "@openmrs/esm-api": "6.3.1-pre.3106",
+    "@openmrs/esm-config": "6.3.1-pre.3106",
+    "@openmrs/esm-context": "6.3.1-pre.3106",
+    "@openmrs/esm-emr-api": "6.3.1-pre.3106",
+    "@openmrs/esm-error-handling": "6.3.1-pre.3106",
+    "@openmrs/esm-extensions": "6.3.1-pre.3106",
+    "@openmrs/esm-feature-flags": "6.3.1-pre.3106",
+    "@openmrs/esm-globals": "6.3.1-pre.3106",
+    "@openmrs/esm-navigation": "6.3.1-pre.3106",
+    "@openmrs/esm-state": "6.3.1-pre.3106",
+    "@openmrs/esm-utils": "6.3.1-pre.3106",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/ConfigurableLink.tsx

@@ -35,16 +35,19 @@ function handleClick(
  * @noInheritDoc
  */
 export interface ConfigurableLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
-  /** The target path or URL. Supports interpolation. See [[navigate]] */
   to: string;
-  /** A dictionary of values to interpolate into the URL, in addition to the default keys `openmrsBase` and `openmrsSpaBase`. */
   templateParams?: TemplateParams;
-  /** A callback to be called just before navigation occurs */
   onBeforeNavigate?: (event: MouseEvent) => void;
 }
 
 /**
  * A React link component which calls [[navigate]] when clicked
+ *
+ * @param to The target path or URL. Supports interpolation. See [[navigate]]
+ * @param templateParams: A dictionary of values to interpolate into the URL, in addition to the default keys `openmrsBase` and `openmrsSpaBase`.
+ * @param onBeforeNavigate A callback to be called just before navigation occurs
+ * @param children Inline elements within the link
+ * @param otherProps Any other valid props for an <a> tag except `href` and `onClick`
  */
 export function ConfigurableLink({
   to,

package/src/ExtensionSlot.tsx

@@ -6,33 +6,26 @@ import { Extension } from './Extension';
 import { useExtensionSlot } from './useExtensionSlot';
 
 export interface ExtensionSlotBaseProps {
-  /** The name of the extension slot */
   name: string;
-  /**
-   * The name of the extension slot
-   * @deprecated Use `name`
-   */
+  /** @deprecated Use `name` */
   extensionSlotName?: string;
-  /**
-   * An optional function for filtering or otherwise modifying
-   *   the list of extensions that will be rendered.
-   */
   select?: (extensions: Array<AssignedExtension>) => Array<AssignedExtension>;
-  /**
-   *Only works if no children are provided*. Passes data
-   *   through as props to the extensions that are mounted here. If `ExtensionSlot`
-   *   has children, you must pass the state through the `state` param of the
-   *   `Extension` component.
-   */
-  state?: Record<string | number | symbol, unknown>;
+  state?: Record<string, unknown>;
 }
 
-export interface ExtensionSlotProps
-  extends ExtensionSlotBaseProps,
-    Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
-  children?: React.ReactNode | ((extension: AssignedExtension, state?: Record<string, unknown>) => React.ReactNode);
+export interface OldExtensionSlotBaseProps {
+  name?: string;
+  /** @deprecated Use `name` */
+  extensionSlotName: string;
+  select?: (extensions: Array<AssignedExtension>) => Array<AssignedExtension>;
+  state?: Record<string, unknown>;
 }
 
+export type ExtensionSlotProps = (OldExtensionSlotBaseProps | ExtensionSlotBaseProps) &
+  Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> & {
+    children?: React.ReactNode | ((extension: AssignedExtension, state?: Record<string, unknown>) => React.ReactNode);
+  };
+
 function defaultSelect(extensions: Array<AssignedExtension>) {
   return extensions;
 }
@@ -42,6 +35,23 @@ function defaultSelect(extensions: Array<AssignedExtension>) {
  * A place with a name. Extensions that get connected to that name
  * will be rendered into this.
  *
+ * @param props.name The name of the extension slot
+ * @param props.select An optional function for filtering or otherwise modifying
+ *   the list of extensions that will be rendered.
+ * @param props.state *Only works if no children are provided*. Passes data
+ *   through as props to the extensions that are mounted here. If `ExtensionSlot`
+ *   has children, you must pass the state through the `state` param of the
+ *   `Extension` component.
+ * @param props.children There are two different ways to use `ExtensionSlot`
+ *   children.
+ *  - Passing a `ReactNode`, the "normal" way. The child must contain the component
+ *     `Extension`. Whatever is passed as the child will be rendered once per extension.
+ *     See the first example below.
+ *  - Passing a function, the "render props" way. The child must be a function
+ *     which takes a [[ConnectedExtension]] as argument and returns a `ReactNode`.
+ *     the resulting react node must contain the component `Extension`. It will
+ *     be run for each extension. See the second example below.
+ *
  * @example
  * Passing a react node as children
  *

package/src/useVisit.ts

@@ -83,13 +83,7 @@ export function useVisit(patientUuid: string, representation = defaultVisitCusto
     if (!retroIsValidating) {
       // if the current visit happened to be active but it just got ended (inactive), remove the
       // visit from context
-      if (
-        previousCurrentVisit.current &&
-        currentVisit &&
-        previousCurrentVisit.current.uuid === currentVisit.uuid &&
-        !previousCurrentVisit.current.stopDatetime &&
-        currentVisit.stopDatetime
-      ) {
+      if (previousCurrentVisit.current && currentVisit && previousCurrentVisit.current.uuid === currentVisit.uuid && !previousCurrentVisit.current.stopDatetime && currentVisit.stopDatetime) {
         setVisitContext(null);
       }
       previousCurrentVisit.current = currentVisit;