@medplum/core 3.2.17 → 3.2.18

package/dist/cjs/index.d.ts

@@ -245,6 +245,12 @@ export declare function assertContextVersionOptional(event: string): asserts eve
  */
 export declare function assertOk<T>(outcome: OperationOutcome, resource: T | undefined): asserts resource is T;
 
+/**
+ * Asserts that a given candidate is a `ReleaseManifest`.
+ * @param candidate - An object assumed to be a `ReleaseManifest`.
+ */
+export declare function assertReleaseManifest(candidate: unknown): asserts candidate is ReleaseManifest;
+
 export declare interface AsyncCrawlerVisitor {
     onEnterObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
     onExitObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
@@ -409,6 +415,18 @@ export declare function capitalize(word: string): string;
  */
 export declare function checkForNull(value: unknown, path: string, issues: OperationOutcomeIssue[]): void;
 
+/**
+ * Tests that a given version string is a valid existing Medplum release version.
+ * @param version - A version to be checked against the existing Medplum repo releases.
+ * @returns `true` if `version` is a valid semver version that corresponds to an existing release, otherwise `false`.
+ */
+export declare function checkIfValidMedplumVersion(version: string): Promise<boolean>;
+
+/**
+ * Clears the locally-cached `ReleaseManifest`s for all versions.
+ */
+export declare function clearReleaseCache(): void;
+
 /**
  * The ClientStorage class is a utility class for storing strings and objects.
  *
@@ -941,8 +959,19 @@ export declare const ExternalSecretSystems: {
     readonly aws_ssm_parameter_store: "aws_ssm_parameter_store";
 };
 
+/**
+ * @returns A version string corresponding to the latest Medplum release version.
+ */
+export declare function fetchLatestVersionString(): Promise<string>;
+
 export declare type FetchLike = (url: string, options?: any) => Promise<any>;
 
+/**
+ * @param version - The version to fetch. If no `version` is provided, defaults to the `latest` version.
+ * @returns - The manifest for the specified or latest version.
+ */
+export declare function fetchVersionManifest(version?: string): Promise<ReleaseManifest>;
+
 export declare const FHIRCAST_EVENT_NAMES: {
     readonly 'Patient-open': "Patient-open";
     readonly 'Patient-close': "Patient-close";
@@ -1737,6 +1766,8 @@ export declare function getValueSliceName(value: any, slices: SliceDefinitionWit
  */
 export declare function getWebSocketUrl(baseUrl: URL | string, path: string): string;
 
+export declare const GITHUB_RELEASES_URL = "https://api.github.com/repos/medplum/medplum/releases";
+
 /**
  * Global schema singleton.
  */
@@ -2420,6 +2451,14 @@ export declare function isValidDate(date: Date): boolean;
  */
 export declare function isValidHostname(input: string): boolean;
 
+/**
+ * Tests that a given version string follows the basic semver pattern of `<int>.<int>.<int>`, which is used for Medplum versions.
+ *
+ * @param version - A version string that should be tested for valid semver semantics.
+ * @returns `true` if `version` is a valid semver version that conforms to the Medplum versioning system, otherwise `false`.
+ */
+export declare function isValidMedplumSemver(version: string): boolean;
+
 /**
  * Memoizes the result of a parameterless function
  * @param fn - The function to be wrapped
@@ -2445,11 +2484,11 @@ export declare class Logger {
     constructor(write: (msg: string) => void, metadata?: Record<string, any>, level?: LogLevel, options?: LoggerOptions | undefined);
     clone(override?: LoggerConfigOverride): Logger;
     private getLoggerConfig;
-    error(msg: string, data?: Record<string, any>): void;
-    warn(msg: string, data?: Record<string, any>): void;
-    info(msg: string, data?: Record<string, any>): void;
-    debug(msg: string, data?: Record<string, any>): void;
-    log(level: LogLevel, msg: string, data?: Record<string, any>): void;
+    error(msg: string, data?: Record<string, any> | Error): void;
+    warn(msg: string, data?: Record<string, any> | Error): void;
+    info(msg: string, data?: Record<string, any> | Error): void;
+    debug(msg: string, data?: Record<string, any> | Error): void;
+    log(level: LogLevel, msg: string, data?: Record<string, any> | Error): void;
 }
 
 export declare interface LoggerConfig {
@@ -2713,6 +2752,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private readonly authorizeUrl;
     private readonly tokenUrl;
     private readonly logoutUrl;
+    private readonly fhircastHubUrl;
     private readonly onUnauthenticated?;
     private readonly autoBatchTime;
     private readonly autoBatchQueue;
@@ -2775,6 +2815,14 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The current logout URL.
      */
     getLogoutUrl(): string;
+    /**
+     * Returns the current FHIRcast Hub URL.
+     * By default, this is set to `https://api.medplum.com/fhircast/STU3`.
+     * This can be overridden by setting the `logoutUrl` option when creating the client.
+     * @category HTTP
+     * @returns The current FHIRcast Hub URL.
+     */
+    getFhircastHubUrl(): string;
     /**
      * Clears all auth state including local storage and session storage.
      * @category Authentication
@@ -4263,6 +4311,16 @@ export declare interface MedplumClientOptions {
      * Use this if you want to use a separate OAuth server.
      */
     logoutUrl?: string;
+    /**
+     * FHIRcast Hub URL.
+     *
+     * Default value is `fhircast/STU3`.
+     *
+     * Can be specified as absolute URL or relative to `baseUrl`.
+     *
+     * Use this if you want to use a different path when connecting to a FHIRcast hub.
+     */
+    fhircastHubUrl?: string;
     /**
      * The client ID.
      *
@@ -5356,6 +5414,14 @@ export declare class ReconnectingWebSocket extends TypedEventTarget<WebSocketEve
     private _clearTimeouts;
 }
 
+export declare type ReleaseManifest = {
+    tag_name: string;
+    assets: {
+        name: string;
+        browser_download_url: string;
+    }[];
+};
+
 /**
  * Removes duplicates in array using FHIRPath equality rules.
  * @param arr - The input array.
@@ -5496,6 +5562,8 @@ export declare function serializeFhircastSubscriptionRequest(subscriptionRequest
 
 export declare function serverError(err: Error): OperationOutcome;
 
+export declare function serverTimeout(msg?: string): OperationOutcome;
+
 /**
  * Sets a code for a given system within a given codeable concept.
  * @param concept - The codeable concept.

package/dist/esm/index.d.ts

@@ -245,6 +245,12 @@ export declare function assertContextVersionOptional(event: string): asserts eve
  */
 export declare function assertOk<T>(outcome: OperationOutcome, resource: T | undefined): asserts resource is T;
 
+/**
+ * Asserts that a given candidate is a `ReleaseManifest`.
+ * @param candidate - An object assumed to be a `ReleaseManifest`.
+ */
+export declare function assertReleaseManifest(candidate: unknown): asserts candidate is ReleaseManifest;
+
 export declare interface AsyncCrawlerVisitor {
     onEnterObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
     onExitObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
@@ -409,6 +415,18 @@ export declare function capitalize(word: string): string;
  */
 export declare function checkForNull(value: unknown, path: string, issues: OperationOutcomeIssue[]): void;
 
+/**
+ * Tests that a given version string is a valid existing Medplum release version.
+ * @param version - A version to be checked against the existing Medplum repo releases.
+ * @returns `true` if `version` is a valid semver version that corresponds to an existing release, otherwise `false`.
+ */
+export declare function checkIfValidMedplumVersion(version: string): Promise<boolean>;
+
+/**
+ * Clears the locally-cached `ReleaseManifest`s for all versions.
+ */
+export declare function clearReleaseCache(): void;
+
 /**
  * The ClientStorage class is a utility class for storing strings and objects.
  *
@@ -941,8 +959,19 @@ export declare const ExternalSecretSystems: {
     readonly aws_ssm_parameter_store: "aws_ssm_parameter_store";
 };
 
+/**
+ * @returns A version string corresponding to the latest Medplum release version.
+ */
+export declare function fetchLatestVersionString(): Promise<string>;
+
 export declare type FetchLike = (url: string, options?: any) => Promise<any>;
 
+/**
+ * @param version - The version to fetch. If no `version` is provided, defaults to the `latest` version.
+ * @returns - The manifest for the specified or latest version.
+ */
+export declare function fetchVersionManifest(version?: string): Promise<ReleaseManifest>;
+
 export declare const FHIRCAST_EVENT_NAMES: {
     readonly 'Patient-open': "Patient-open";
     readonly 'Patient-close': "Patient-close";
@@ -1737,6 +1766,8 @@ export declare function getValueSliceName(value: any, slices: SliceDefinitionWit
  */
 export declare function getWebSocketUrl(baseUrl: URL | string, path: string): string;
 
+export declare const GITHUB_RELEASES_URL = "https://api.github.com/repos/medplum/medplum/releases";
+
 /**
  * Global schema singleton.
  */
@@ -2420,6 +2451,14 @@ export declare function isValidDate(date: Date): boolean;
  */
 export declare function isValidHostname(input: string): boolean;
 
+/**
+ * Tests that a given version string follows the basic semver pattern of `<int>.<int>.<int>`, which is used for Medplum versions.
+ *
+ * @param version - A version string that should be tested for valid semver semantics.
+ * @returns `true` if `version` is a valid semver version that conforms to the Medplum versioning system, otherwise `false`.
+ */
+export declare function isValidMedplumSemver(version: string): boolean;
+
 /**
  * Memoizes the result of a parameterless function
  * @param fn - The function to be wrapped
@@ -2445,11 +2484,11 @@ export declare class Logger {
     constructor(write: (msg: string) => void, metadata?: Record<string, any>, level?: LogLevel, options?: LoggerOptions | undefined);
     clone(override?: LoggerConfigOverride): Logger;
     private getLoggerConfig;
-    error(msg: string, data?: Record<string, any>): void;
-    warn(msg: string, data?: Record<string, any>): void;
-    info(msg: string, data?: Record<string, any>): void;
-    debug(msg: string, data?: Record<string, any>): void;
-    log(level: LogLevel, msg: string, data?: Record<string, any>): void;
+    error(msg: string, data?: Record<string, any> | Error): void;
+    warn(msg: string, data?: Record<string, any> | Error): void;
+    info(msg: string, data?: Record<string, any> | Error): void;
+    debug(msg: string, data?: Record<string, any> | Error): void;
+    log(level: LogLevel, msg: string, data?: Record<string, any> | Error): void;
 }
 
 export declare interface LoggerConfig {
@@ -2713,6 +2752,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private readonly authorizeUrl;
     private readonly tokenUrl;
     private readonly logoutUrl;
+    private readonly fhircastHubUrl;
     private readonly onUnauthenticated?;
     private readonly autoBatchTime;
     private readonly autoBatchQueue;
@@ -2775,6 +2815,14 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The current logout URL.
      */
     getLogoutUrl(): string;
+    /**
+     * Returns the current FHIRcast Hub URL.
+     * By default, this is set to `https://api.medplum.com/fhircast/STU3`.
+     * This can be overridden by setting the `logoutUrl` option when creating the client.
+     * @category HTTP
+     * @returns The current FHIRcast Hub URL.
+     */
+    getFhircastHubUrl(): string;
     /**
      * Clears all auth state including local storage and session storage.
      * @category Authentication
@@ -4263,6 +4311,16 @@ export declare interface MedplumClientOptions {
      * Use this if you want to use a separate OAuth server.
      */
     logoutUrl?: string;
+    /**
+     * FHIRcast Hub URL.
+     *
+     * Default value is `fhircast/STU3`.
+     *
+     * Can be specified as absolute URL or relative to `baseUrl`.
+     *
+     * Use this if you want to use a different path when connecting to a FHIRcast hub.
+     */
+    fhircastHubUrl?: string;
     /**
      * The client ID.
      *
@@ -5356,6 +5414,14 @@ export declare class ReconnectingWebSocket extends TypedEventTarget<WebSocketEve
     private _clearTimeouts;
 }
 
+export declare type ReleaseManifest = {
+    tag_name: string;
+    assets: {
+        name: string;
+        browser_download_url: string;
+    }[];
+};
+
 /**
  * Removes duplicates in array using FHIRPath equality rules.
  * @param arr - The input array.
@@ -5496,6 +5562,8 @@ export declare function serializeFhircastSubscriptionRequest(subscriptionRequest
 
 export declare function serverError(err: Error): OperationOutcome;
 
+export declare function serverTimeout(msg?: string): OperationOutcome;
+
 /**
  * Sets a code for a given system within a given codeable concept.
  * @param concept - The codeable concept.