@medplum/core 4.1.5 → 4.1.6

package/dist/cjs/index.d.ts

@@ -276,6 +276,7 @@ export declare interface AtomContext {
 }
 
 export declare interface BackgroundJobContext {
+    project?: WithId<Project>;
     interaction: BackgroundJobInteraction;
 }
 
@@ -1964,6 +1965,16 @@ export declare class Hl7Field {
      * @returns The parsed HL7 field.
      */
     static parse(text: string, context?: Hl7Context): Hl7Field;
+    /**
+     * Sets a component value at the specified indices.
+     * Note that the indices are 1-based, not 0-based.
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 /**
@@ -2032,6 +2043,16 @@ export declare class Hl7Message {
      * @returns The parsed HL7 message.
      */
     static parse(text: string): Hl7Message;
+    /**
+     * Sets or replaces a segment at the specified index.
+     * Only allows MSH header to be replaced as first segment.
+     * If index is a number and is larger than the length of the segments array, it will be appended as the last segment.
+     * If the index is a string, replaces the first segment with that name.
+     * @param index - The segment index or name
+     * @param segment - The new segment to set
+     * @returns true if the segment was set, false otherwise
+     */
+    setSegment(index: number | string, segment: Hl7Segment): boolean;
 }
 
 /**
@@ -2053,7 +2074,7 @@ export declare class Hl7Segment {
      * Returns an HL7 field by index.
      * @param index - The HL7 field index.
      * @returns The HL7 field.
-     * @deprecated Use getSegment() instead. This method includes the segment name in the index, which leads to confusing behavior. This method will be removed in a future release.
+     * @deprecated Use getField() instead. This method includes the segment name in the index, which leads to confusing behavior. This method will be removed in a future release.
      */
     get(index: number): Hl7Field;
     /**
@@ -2101,6 +2122,26 @@ export declare class Hl7Segment {
      * @returns The parsed HL7 segment.
      */
     static parse(text: string, context?: Hl7Context): Hl7Segment;
+    /**
+     * Sets a field at the specified index. If that index does not exist, it will be added.
+     * Note that the index is 1-based, not 0-based.
+     * @param index - The field index
+     * @param field - The new field value
+     * @returns true if the field was set, false otherwise
+     */
+    setField(index: number, field: Hl7Field | string): boolean;
+    /**
+     * Sets a component value by field index and component index.
+     * This is a shortcut for `getField(field).setComponent(component, value)`.
+     * Note that both indices are 1-based, not 0-based.
+     * @param fieldIndex - The HL7 field index
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(fieldIndex: number, component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 export declare const HTTP_HL7_ORG = "http://hl7.org";
@@ -2960,6 +3001,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private refreshPromise?;
     private profilePromise?;
     private sessionDetails?;
+    private currentRateLimits?;
     private basicAuth?;
     private initPromise;
     private initComplete;
@@ -4172,6 +4214,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private fetchWithRetry;
     private logRequest;
     private logResponse;
+    private setCurrentRateLimit;
+    /**
+     * Reports the last-seen rate limit information from the server.
+     * @returns Array of applicable rate limits.
+     */
+    rateLimitStatus(): RateLimitInfo[];
+    private getRetryDelay;
     private pollStatus;
     /**
      * Executes a batch of requests that were automatically batched together.
@@ -5503,6 +5552,12 @@ export declare type ProtocolsProvider = null | string | string[];
  */
 export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+export declare type RateLimitInfo = {
+    name: string;
+    remainingUnits: number;
+    secondsUntilReset: number;
+};
+
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
  * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js

package/dist/esm/index.d.ts

@@ -276,6 +276,7 @@ export declare interface AtomContext {
 }
 
 export declare interface BackgroundJobContext {
+    project?: WithId<Project>;
     interaction: BackgroundJobInteraction;
 }
 
@@ -1964,6 +1965,16 @@ export declare class Hl7Field {
      * @returns The parsed HL7 field.
      */
     static parse(text: string, context?: Hl7Context): Hl7Field;
+    /**
+     * Sets a component value at the specified indices.
+     * Note that the indices are 1-based, not 0-based.
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 /**
@@ -2032,6 +2043,16 @@ export declare class Hl7Message {
      * @returns The parsed HL7 message.
      */
     static parse(text: string): Hl7Message;
+    /**
+     * Sets or replaces a segment at the specified index.
+     * Only allows MSH header to be replaced as first segment.
+     * If index is a number and is larger than the length of the segments array, it will be appended as the last segment.
+     * If the index is a string, replaces the first segment with that name.
+     * @param index - The segment index or name
+     * @param segment - The new segment to set
+     * @returns true if the segment was set, false otherwise
+     */
+    setSegment(index: number | string, segment: Hl7Segment): boolean;
 }
 
 /**
@@ -2053,7 +2074,7 @@ export declare class Hl7Segment {
      * Returns an HL7 field by index.
      * @param index - The HL7 field index.
      * @returns The HL7 field.
-     * @deprecated Use getSegment() instead. This method includes the segment name in the index, which leads to confusing behavior. This method will be removed in a future release.
+     * @deprecated Use getField() instead. This method includes the segment name in the index, which leads to confusing behavior. This method will be removed in a future release.
      */
     get(index: number): Hl7Field;
     /**
@@ -2101,6 +2122,26 @@ export declare class Hl7Segment {
      * @returns The parsed HL7 segment.
      */
     static parse(text: string, context?: Hl7Context): Hl7Segment;
+    /**
+     * Sets a field at the specified index. If that index does not exist, it will be added.
+     * Note that the index is 1-based, not 0-based.
+     * @param index - The field index
+     * @param field - The new field value
+     * @returns true if the field was set, false otherwise
+     */
+    setField(index: number, field: Hl7Field | string): boolean;
+    /**
+     * Sets a component value by field index and component index.
+     * This is a shortcut for `getField(field).setComponent(component, value)`.
+     * Note that both indices are 1-based, not 0-based.
+     * @param fieldIndex - The HL7 field index
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(fieldIndex: number, component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 export declare const HTTP_HL7_ORG = "http://hl7.org";
@@ -2960,6 +3001,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private refreshPromise?;
     private profilePromise?;
     private sessionDetails?;
+    private currentRateLimits?;
     private basicAuth?;
     private initPromise;
     private initComplete;
@@ -4172,6 +4214,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private fetchWithRetry;
     private logRequest;
     private logResponse;
+    private setCurrentRateLimit;
+    /**
+     * Reports the last-seen rate limit information from the server.
+     * @returns Array of applicable rate limits.
+     */
+    rateLimitStatus(): RateLimitInfo[];
+    private getRetryDelay;
     private pollStatus;
     /**
      * Executes a batch of requests that were automatically batched together.
@@ -5503,6 +5552,12 @@ export declare type ProtocolsProvider = null | string | string[];
  */
 export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+export declare type RateLimitInfo = {
+    name: string;
+    remainingUnits: number;
+    secondsUntilReset: number;
+};
+
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
  * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js