@medplum/core 3.1.10 → 3.1.11

package/dist/cjs/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-
 import { AccessPolicy } from '@medplum/fhirtypes';
 import { AccessPolicyResource } from '@medplum/fhirtypes';
 import { Address } from '@medplum/fhirtypes';
@@ -55,6 +53,8 @@ import type { TFontDictionary } from 'pdfmake/interfaces';
 import { Timing } from '@medplum/fhirtypes';
 import { UserConfiguration } from '@medplum/fhirtypes';
 import { ValueSet } from '@medplum/fhirtypes';
+import { ViewDefinition } from '@medplum/fhirtypes';
+import { ViewDefinitionSelect } from '@medplum/fhirtypes';
 
 export declare function accepted(location: string): OperationOutcome;
 
@@ -801,6 +801,14 @@ export declare function evalFhirPath(expression: string, input: unknown): unknow
  */
 export declare function evalFhirPathTyped(expression: string, input: TypedValue[], variables?: Record<string, TypedValue>): TypedValue[];
 
+/**
+ * Evaluates a SQL-on-FHIR view on a set of FHIR resources.
+ * @param view - The view definition.
+ * @param resources - The array of FHIR resources.
+ * @returns The output rows.
+ */
+export declare function evalSqlOnFhir(view: ViewDefinition, resources: Resource[]): OutputRow[];
+
 declare interface Event_2 {
     readonly type: string;
     readonly defaultPrevented?: boolean;
@@ -2579,7 +2587,7 @@ export declare const MEDPLUM_VERSION: string;
  *    <meta name="algolia:pageRank" content="100" />
  *  </head>
  */
-export declare class MedplumClient extends EventTarget_2 {
+export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMap> {
     private readonly options;
     private readonly fetch;
     private readonly createPdfImpl?;
@@ -2855,7 +2863,7 @@ export declare class MedplumClient extends EventTarget_2 {
     getExternalAuthRedirectUri(authorizeUrl: string, clientId: string, redirectUri: string, loginRequest: BaseLoginRequest, pkceEnabled?: boolean): string;
     /**
      * Builds a FHIR URL from a collection of URL path components.
-     * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
+     * For example, `fhirUrl('Patient', '123')` returns `fhir/R4/Patient/123`.
      * @category HTTP
      * @param path - The path component of the URL.
      * @returns The well-formed FHIR URL.
@@ -3987,7 +3995,6 @@ export declare class MedplumClient extends EventTarget_2 {
      * This synchronizes state across browser windows and browser tabs.
      */
     private setupStorageListener;
-    private retryCatch;
     /**
      * Gets the `SubscriptionManager` for WebSocket subscriptions.
      *
@@ -4056,6 +4063,27 @@ export declare class MedplumClient extends EventTarget_2 {
     getMasterSubscriptionEmitter(): SubscriptionEmitter;
 }
 
+/**
+ * This map enumerates all the lifecycle events that `MedplumClient` emits and what the shape of the `Event` is.
+ */
+export declare type MedplumClientEventMap = {
+    change: {
+        type: 'change';
+    };
+    offline: {
+        type: 'offline';
+    };
+    profileRefreshing: {
+        type: 'profileRefreshing';
+    };
+    profileRefreshed: {
+        type: 'profileRefreshed';
+    };
+    storageInitialized: {
+        type: 'storageInitialized';
+    };
+};
+
 /**
  * The MedplumClientOptions interface defines configuration options for MedplumClient.
  *
@@ -4346,6 +4374,10 @@ export declare interface MedplumRequestOptions extends RequestInit {
      * Default value is 1000 (1 second).
      */
     pollStatusPeriod?: number;
+    /**
+     * Optional max number of retries that should be made in the case of a failed request. Default is `2`.
+     */
+    maxRetries?: number;
 }
 
 export declare interface MedplumSourceInfraConfig {
@@ -4680,6 +4712,11 @@ export declare class OrAtom extends BooleanInfixOperatorAtom {
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
 }
 
+/**
+ * SQL on FHIR output row.
+ */
+export declare type OutputRow = Record<string, any>;
+
 /**
  * Parses a FHIR criteria string into a SearchRequest.
  * FHIR criteria strings are found on resources such as Subscription.
@@ -5188,6 +5225,21 @@ export declare interface SearchRequest<T extends Resource = Resource> {
     types?: T['resourceType'][];
 }
 
+/**
+ * Represents a "selection structure" in the SQL-on-FHIR specification.
+ *
+ * In practice, this can be a ViewDefinition or ViewDefinitionSelect.
+ *
+ * TypeScript does not like checks for properties that are not part of the type, so we use this interface instead.
+ */
+export declare interface SelectionStructure {
+    forEach?: string;
+    forEachOrNull?: string;
+    column?: ViewDefinitionSelect['column'];
+    select?: SelectionStructure[];
+    unionAll?: SelectionStructure[];
+}
+
 /**
  * Creates a serialized url-encoded payload for a `FHIRcast` subscription from a `SubscriptionRequest` object that can be directly used in an HTTP request to the Hub.
  *

package/dist/esm/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-
 import { AccessPolicy } from '@medplum/fhirtypes';
 import { AccessPolicyResource } from '@medplum/fhirtypes';
 import { Address } from '@medplum/fhirtypes';
@@ -55,6 +53,8 @@ import type { TFontDictionary } from 'pdfmake/interfaces';
 import { Timing } from '@medplum/fhirtypes';
 import { UserConfiguration } from '@medplum/fhirtypes';
 import { ValueSet } from '@medplum/fhirtypes';
+import { ViewDefinition } from '@medplum/fhirtypes';
+import { ViewDefinitionSelect } from '@medplum/fhirtypes';
 
 export declare function accepted(location: string): OperationOutcome;
 
@@ -801,6 +801,14 @@ export declare function evalFhirPath(expression: string, input: unknown): unknow
  */
 export declare function evalFhirPathTyped(expression: string, input: TypedValue[], variables?: Record<string, TypedValue>): TypedValue[];
 
+/**
+ * Evaluates a SQL-on-FHIR view on a set of FHIR resources.
+ * @param view - The view definition.
+ * @param resources - The array of FHIR resources.
+ * @returns The output rows.
+ */
+export declare function evalSqlOnFhir(view: ViewDefinition, resources: Resource[]): OutputRow[];
+
 declare interface Event_2 {
     readonly type: string;
     readonly defaultPrevented?: boolean;
@@ -2579,7 +2587,7 @@ export declare const MEDPLUM_VERSION: string;
  *    <meta name="algolia:pageRank" content="100" />
  *  </head>
  */
-export declare class MedplumClient extends EventTarget_2 {
+export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMap> {
     private readonly options;
     private readonly fetch;
     private readonly createPdfImpl?;
@@ -2855,7 +2863,7 @@ export declare class MedplumClient extends EventTarget_2 {
     getExternalAuthRedirectUri(authorizeUrl: string, clientId: string, redirectUri: string, loginRequest: BaseLoginRequest, pkceEnabled?: boolean): string;
     /**
      * Builds a FHIR URL from a collection of URL path components.
-     * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
+     * For example, `fhirUrl('Patient', '123')` returns `fhir/R4/Patient/123`.
      * @category HTTP
      * @param path - The path component of the URL.
      * @returns The well-formed FHIR URL.
@@ -3987,7 +3995,6 @@ export declare class MedplumClient extends EventTarget_2 {
      * This synchronizes state across browser windows and browser tabs.
      */
     private setupStorageListener;
-    private retryCatch;
     /**
      * Gets the `SubscriptionManager` for WebSocket subscriptions.
      *
@@ -4056,6 +4063,27 @@ export declare class MedplumClient extends EventTarget_2 {
     getMasterSubscriptionEmitter(): SubscriptionEmitter;
 }
 
+/**
+ * This map enumerates all the lifecycle events that `MedplumClient` emits and what the shape of the `Event` is.
+ */
+export declare type MedplumClientEventMap = {
+    change: {
+        type: 'change';
+    };
+    offline: {
+        type: 'offline';
+    };
+    profileRefreshing: {
+        type: 'profileRefreshing';
+    };
+    profileRefreshed: {
+        type: 'profileRefreshed';
+    };
+    storageInitialized: {
+        type: 'storageInitialized';
+    };
+};
+
 /**
  * The MedplumClientOptions interface defines configuration options for MedplumClient.
  *
@@ -4346,6 +4374,10 @@ export declare interface MedplumRequestOptions extends RequestInit {
      * Default value is 1000 (1 second).
      */
     pollStatusPeriod?: number;
+    /**
+     * Optional max number of retries that should be made in the case of a failed request. Default is `2`.
+     */
+    maxRetries?: number;
 }
 
 export declare interface MedplumSourceInfraConfig {
@@ -4680,6 +4712,11 @@ export declare class OrAtom extends BooleanInfixOperatorAtom {
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
 }
 
+/**
+ * SQL on FHIR output row.
+ */
+export declare type OutputRow = Record<string, any>;
+
 /**
  * Parses a FHIR criteria string into a SearchRequest.
  * FHIR criteria strings are found on resources such as Subscription.
@@ -5188,6 +5225,21 @@ export declare interface SearchRequest<T extends Resource = Resource> {
     types?: T['resourceType'][];
 }
 
+/**
+ * Represents a "selection structure" in the SQL-on-FHIR specification.
+ *
+ * In practice, this can be a ViewDefinition or ViewDefinitionSelect.
+ *
+ * TypeScript does not like checks for properties that are not part of the type, so we use this interface instead.
+ */
+export declare interface SelectionStructure {
+    forEach?: string;
+    forEachOrNull?: string;
+    column?: ViewDefinitionSelect['column'];
+    select?: SelectionStructure[];
+    unionAll?: SelectionStructure[];
+}
+
 /**
  * Creates a serialized url-encoded payload for a `FHIRcast` subscription from a `SubscriptionRequest` object that can be directly used in an HTTP request to the Hub.
  *