@medplum/core 5.0.10 → 5.0.12

package/dist/cjs/index.d.ts

@@ -370,6 +370,22 @@ export declare interface BotEvent<T = unknown> {
     readonly requester?: Reference<Bot | ClientApplication | Patient | Practitioner | RelatedPerson>;
     /** Headers from the original request, when invoked by HTTP request */
     readonly headers?: Record<string, string | string[] | undefined>;
+    /** Optional response stream when invoked with SSE (Server Side Events) */
+    readonly responseStream?: BotResponseStream;
+}
+
+/**
+ * Response stream interface for bot streaming responses.
+ * Compatible with both VMContext and AWS Lambda runtimes.
+ */
+export declare interface BotResponseStream extends NodeJS.WritableStream {
+    /**
+     * Starts streaming with the given status code and headers.
+     * Must be called before write() to commit the HTTP response.
+     * @param statusCode - HTTP status code (e.g., 200)
+     * @param headers - HTTP headers to send
+     */
+    startStreaming(statusCode: number, headers: Record<string, string>): void;
 }
 
 /**
@@ -1102,6 +1118,9 @@ export declare interface EmailPasswordLoginRequest extends BaseLoginRequest {
     readonly remember?: boolean;
 }
 
+/** Constant empty array. */
+export declare const EMPTY: readonly [];
+
 export declare class EmptySetAtom implements Atom {
     eval(): [];
     toString(): string;
@@ -1911,6 +1930,16 @@ export declare function formatTime(time: string | undefined, locales?: Intl.Loca
  */
 export declare function formatTiming(timing: Timing | undefined): string;
 
+/**
+ * Formats a FHIR time string as a human readable string.
+ * The viewer's timezone does not affect the display.
+ * @param time - The time to format, a string like `HH:mm` or `HH:mm:ss`
+ * @param locales - Optional locales.
+ * @param options - Optional time format options.
+ * @returns The formatted time string.
+ */
+export declare function formatWallTime(time: string | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions): string;
+
 export declare class FunctionAtom implements Atom {
     readonly name: string;
     readonly args: Atom[];
@@ -3383,7 +3412,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private readonly fetch;
     private readonly createPdfImpl?;
     private readonly storage;
-    private readonly requestCache;
+    protected readonly requestCache: LRUCache<RequestCacheEntry> | undefined;
     private readonly cacheTime;
     private readonly baseUrl;
     private readonly fhirBaseUrl;
@@ -3842,7 +3871,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param reference - The FHIR reference.
      * @returns The resource if it is available in the cache; undefined otherwise.
      */
-    getCachedReference<T extends Resource>(reference: Reference<T>): T | undefined;
+    getCachedReference<T extends Resource>(reference: Reference<T>): WithId<T> | undefined;
     /**
      * Reads a resource by resource type and ID.
      *
@@ -3889,9 +3918,10 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * If the schema is already cached, the promise is resolved immediately.
      * @category Schema
      * @param resourceType - The FHIR resource type.
+     * @param options - Optional fetch options.
      * @returns Promise to a schema with the requested resource type.
      */
-    requestSchema(resourceType: string): Promise<void>;
+    requestSchema(resourceType: string, options?: MedplumRequestOptions): Promise<void>;
     /**
      * Requests the schema for a profile.
      * If the schema is already cached, the promise is resolved immediately.
@@ -4618,6 +4648,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns Promise to the bundle.
      */
     private getBundle;
+    /**
+     * Returns true if caching is enabled for the given request options.
+     * @param options - Optional fetch options for cache settings.
+     * @returns True if caching is enabled.
+     */
+    private isCacheEnabled;
     /**
      * Returns the cache entry if available and not expired.
      * @param key - The cache key to retrieve.
@@ -4629,6 +4665,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Adds a readable promise to the cache.
      * @param key - The cache key to store.
      * @param value - The readable promise to store.
+     * @param options - Optional fetch options for cache settings.
      */
     private setCacheEntry;
     /**
@@ -4636,6 +4673,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * This is used in cases where the resource is loaded indirectly.
      * For example, when a resource is loaded as part of a Bundle.
      * @param resource - The resource to cache.
+     * @param options - Optional fetch options for cache settings.
      */
     private cacheResource;
     /**
@@ -4679,6 +4717,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param contentType - The new content type to set.
      */
     private setRequestContentType;
+    /**
+     * Returns a header from fetch options.
+     * @param options - The fetch options.
+     * @param key - The header key.
+     * @returns The header value if found.
+     */
+    private getRequestHeader;
     /**
      * Sets a header on fetch options.
      * @param options - The fetch options.
@@ -4908,6 +4953,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns Promise that returns a project membership or an operation outcome.
      */
     invite(projectId: string, body: InviteRequest): Promise<ProjectMembership | OperationOutcome>;
+    private handleTokenError;
     /**
      * Makes a POST request to the tokens endpoint.
      * See {@link https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint | OpenID Connect Core 1.0 TokenEndpoint} for full details.
@@ -5231,7 +5277,7 @@ export declare interface MedplumClientOptions {
      * - 'basic': Log method, URL, and status code only (no sensitive headers)
      * - 'verbose': Log all details including headers (may include sensitive data like tokens)
      *
-     * @default 'none'
+     * @defaultValue 'none'
      */
     logLevel?: ClientLogLevel;
     /**
@@ -5719,14 +5765,14 @@ export declare class OperationOutcomeError extends Error {
 }
 
 /**
- * Returns a string represenation of the operation outcome issue.
+ * Returns a string representation of the operation outcome issue.
  * @param issue - The operation outcome issue.
  * @returns The string representation of the operation outcome issue.
  */
 export declare function operationOutcomeIssueToString(issue: OperationOutcomeIssue): string;
 
 /**
- * Returns a string represenation of the operation outcome.
+ * Returns a string representation of the operation outcome.
  * @param outcome - The operation outcome.
  * @returns The string representation of the operation outcome.
  */
@@ -6391,7 +6437,12 @@ export declare class ParserBuilder {
   */
  export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
 
- export declare interface RequestProfileSchemaOptions {
+ export declare interface RequestCacheEntry {
+     readonly requestTime: number;
+     readonly value: ReadablePromise<any>;
+ }
+
+ export declare interface RequestProfileSchemaOptions extends MedplumRequestOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;
  }
@@ -6551,10 +6602,21 @@ export declare class ParserBuilder {
 
  /**
   * Sleeps for the specified number of milliseconds.
-  * @param ms - Time delay in milliseconds
+  * @param ms - Time delay in milliseconds.
+  * @param options - Optional sleep options.
   * @returns A promise that resolves after the specified number of milliseconds.
   */
- export declare const sleep: (ms: number) => Promise<void>;
+ export declare const sleep: (ms: number, options?: SleepOptions) => Promise<void>;
+
+ /**
+  * Sleep options.
+  */
+ export declare interface SleepOptions {
+     /**
+      * Optional `AbortSignal` that can be used to cancel the scheduled sleep.
+      */
+     readonly signal?: AbortSignal | null;
+ }
 
  export declare interface SliceDefinition extends Omit<InternalSchemaElement, 'slicing'> {
      name: string;
@@ -7058,6 +7120,7 @@ export declare class ParserBuilder {
      collect?: {
          tokens?: Record<string, TypedValueWithPath[]>;
      };
+     base64BinaryMaxBytes?: number;
  }
 
  export declare type ValueOrExternalSecret<T extends ExternalSecretPrimitive> = T | ExternalSecret<T>;
@@ -7072,6 +7135,7 @@ export declare class ParserBuilder {
      date?: string;
      offset?: number;
      count?: number;
+     displayLanguage?: string;
  }
 
  /**

package/dist/esm/index.d.ts

@@ -370,6 +370,22 @@ export declare interface BotEvent<T = unknown> {
     readonly requester?: Reference<Bot | ClientApplication | Patient | Practitioner | RelatedPerson>;
     /** Headers from the original request, when invoked by HTTP request */
     readonly headers?: Record<string, string | string[] | undefined>;
+    /** Optional response stream when invoked with SSE (Server Side Events) */
+    readonly responseStream?: BotResponseStream;
+}
+
+/**
+ * Response stream interface for bot streaming responses.
+ * Compatible with both VMContext and AWS Lambda runtimes.
+ */
+export declare interface BotResponseStream extends NodeJS.WritableStream {
+    /**
+     * Starts streaming with the given status code and headers.
+     * Must be called before write() to commit the HTTP response.
+     * @param statusCode - HTTP status code (e.g., 200)
+     * @param headers - HTTP headers to send
+     */
+    startStreaming(statusCode: number, headers: Record<string, string>): void;
 }
 
 /**
@@ -1102,6 +1118,9 @@ export declare interface EmailPasswordLoginRequest extends BaseLoginRequest {
     readonly remember?: boolean;
 }
 
+/** Constant empty array. */
+export declare const EMPTY: readonly [];
+
 export declare class EmptySetAtom implements Atom {
     eval(): [];
     toString(): string;
@@ -1911,6 +1930,16 @@ export declare function formatTime(time: string | undefined, locales?: Intl.Loca
  */
 export declare function formatTiming(timing: Timing | undefined): string;
 
+/**
+ * Formats a FHIR time string as a human readable string.
+ * The viewer's timezone does not affect the display.
+ * @param time - The time to format, a string like `HH:mm` or `HH:mm:ss`
+ * @param locales - Optional locales.
+ * @param options - Optional time format options.
+ * @returns The formatted time string.
+ */
+export declare function formatWallTime(time: string | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions): string;
+
 export declare class FunctionAtom implements Atom {
     readonly name: string;
     readonly args: Atom[];
@@ -3383,7 +3412,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private readonly fetch;
     private readonly createPdfImpl?;
     private readonly storage;
-    private readonly requestCache;
+    protected readonly requestCache: LRUCache<RequestCacheEntry> | undefined;
     private readonly cacheTime;
     private readonly baseUrl;
     private readonly fhirBaseUrl;
@@ -3842,7 +3871,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param reference - The FHIR reference.
      * @returns The resource if it is available in the cache; undefined otherwise.
      */
-    getCachedReference<T extends Resource>(reference: Reference<T>): T | undefined;
+    getCachedReference<T extends Resource>(reference: Reference<T>): WithId<T> | undefined;
     /**
      * Reads a resource by resource type and ID.
      *
@@ -3889,9 +3918,10 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * If the schema is already cached, the promise is resolved immediately.
      * @category Schema
      * @param resourceType - The FHIR resource type.
+     * @param options - Optional fetch options.
      * @returns Promise to a schema with the requested resource type.
      */
-    requestSchema(resourceType: string): Promise<void>;
+    requestSchema(resourceType: string, options?: MedplumRequestOptions): Promise<void>;
     /**
      * Requests the schema for a profile.
      * If the schema is already cached, the promise is resolved immediately.
@@ -4618,6 +4648,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns Promise to the bundle.
      */
     private getBundle;
+    /**
+     * Returns true if caching is enabled for the given request options.
+     * @param options - Optional fetch options for cache settings.
+     * @returns True if caching is enabled.
+     */
+    private isCacheEnabled;
     /**
      * Returns the cache entry if available and not expired.
      * @param key - The cache key to retrieve.
@@ -4629,6 +4665,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Adds a readable promise to the cache.
      * @param key - The cache key to store.
      * @param value - The readable promise to store.
+     * @param options - Optional fetch options for cache settings.
      */
     private setCacheEntry;
     /**
@@ -4636,6 +4673,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * This is used in cases where the resource is loaded indirectly.
      * For example, when a resource is loaded as part of a Bundle.
      * @param resource - The resource to cache.
+     * @param options - Optional fetch options for cache settings.
      */
     private cacheResource;
     /**
@@ -4679,6 +4717,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param contentType - The new content type to set.
      */
     private setRequestContentType;
+    /**
+     * Returns a header from fetch options.
+     * @param options - The fetch options.
+     * @param key - The header key.
+     * @returns The header value if found.
+     */
+    private getRequestHeader;
     /**
      * Sets a header on fetch options.
      * @param options - The fetch options.
@@ -4908,6 +4953,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns Promise that returns a project membership or an operation outcome.
      */
     invite(projectId: string, body: InviteRequest): Promise<ProjectMembership | OperationOutcome>;
+    private handleTokenError;
     /**
      * Makes a POST request to the tokens endpoint.
      * See {@link https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint | OpenID Connect Core 1.0 TokenEndpoint} for full details.
@@ -5231,7 +5277,7 @@ export declare interface MedplumClientOptions {
      * - 'basic': Log method, URL, and status code only (no sensitive headers)
      * - 'verbose': Log all details including headers (may include sensitive data like tokens)
      *
-     * @default 'none'
+     * @defaultValue 'none'
      */
     logLevel?: ClientLogLevel;
     /**
@@ -5719,14 +5765,14 @@ export declare class OperationOutcomeError extends Error {
 }
 
 /**
- * Returns a string represenation of the operation outcome issue.
+ * Returns a string representation of the operation outcome issue.
  * @param issue - The operation outcome issue.
  * @returns The string representation of the operation outcome issue.
  */
 export declare function operationOutcomeIssueToString(issue: OperationOutcomeIssue): string;
 
 /**
- * Returns a string represenation of the operation outcome.
+ * Returns a string representation of the operation outcome.
  * @param outcome - The operation outcome.
  * @returns The string representation of the operation outcome.
  */
@@ -6391,7 +6437,12 @@ export declare class ParserBuilder {
   */
  export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
 
- export declare interface RequestProfileSchemaOptions {
+ export declare interface RequestCacheEntry {
+     readonly requestTime: number;
+     readonly value: ReadablePromise<any>;
+ }
+
+ export declare interface RequestProfileSchemaOptions extends MedplumRequestOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;
  }
@@ -6551,10 +6602,21 @@ export declare class ParserBuilder {
 
  /**
   * Sleeps for the specified number of milliseconds.
-  * @param ms - Time delay in milliseconds
+  * @param ms - Time delay in milliseconds.
+  * @param options - Optional sleep options.
   * @returns A promise that resolves after the specified number of milliseconds.
   */
- export declare const sleep: (ms: number) => Promise<void>;
+ export declare const sleep: (ms: number, options?: SleepOptions) => Promise<void>;
+
+ /**
+  * Sleep options.
+  */
+ export declare interface SleepOptions {
+     /**
+      * Optional `AbortSignal` that can be used to cancel the scheduled sleep.
+      */
+     readonly signal?: AbortSignal | null;
+ }
 
  export declare interface SliceDefinition extends Omit<InternalSchemaElement, 'slicing'> {
      name: string;
@@ -7058,6 +7120,7 @@ export declare class ParserBuilder {
      collect?: {
          tokens?: Record<string, TypedValueWithPath[]>;
      };
+     base64BinaryMaxBytes?: number;
  }
 
  export declare type ValueOrExternalSecret<T extends ExternalSecretPrimitive> = T | ExternalSecret<T>;
@@ -7072,6 +7135,7 @@ export declare class ParserBuilder {
      date?: string;
      offset?: number;
      count?: number;
+     displayLanguage?: string;
  }
 
  /**