@medplum/core 3.2.25 → 3.2.27

package/dist/cjs/index.d.ts

@@ -417,10 +417,11 @@ export declare function checkForNull(value: unknown, path: string, issues: Opera
 
 /**
  * Tests that a given version string is a valid existing Medplum release version.
+ * @param appName - The name of the app to check the version for.
  * @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>;
+export declare function checkIfValidMedplumVersion(appName: string, version: string): Promise<boolean>;
 
 /**
  * Clears the locally-cached `ReleaseManifest`s for all versions.
@@ -962,17 +963,22 @@ export declare const ExternalSecretSystems: {
 };
 
 /**
+ * Fetches the latest Medplum release version string.
+ * @param appName - The name of the app to fetch the latest version for.
  * @returns A version string corresponding to the latest Medplum release version.
  */
-export declare function fetchLatestVersionString(): Promise<string>;
+export declare function fetchLatestVersionString(appName: string): Promise<string>;
 
 export declare type FetchLike = (url: string, options?: any) => Promise<any>;
 
 /**
+ * Fetches the manifest for a given Medplum release version.
+ * @param appName - The name of the app to fetch the manifest for.
  * @param version - The version to fetch. If no `version` is provided, defaults to the `latest` version.
+ * @param params - An optional list of key-value pairs to be appended to the URL query string.
  * @returns - The manifest for the specified or latest version.
  */
-export declare function fetchVersionManifest(version?: string): Promise<ReleaseManifest>;
+export declare function fetchVersionManifest(appName: string, version?: string, params?: Record<string, string>): Promise<ReleaseManifest>;
 
 export declare const FHIRCAST_EVENT_NAMES: {
     readonly 'Patient-open': "Patient-open";
@@ -1342,6 +1348,17 @@ export declare const fhirTypeToJsType: {
     readonly 'http://hl7.org/fhirpath/System.String': "string";
 };
 
+export declare class FileBuilder {
+    private readonly indent;
+    private readonly b;
+    indentCount: number;
+    constructor(indent?: string, header?: boolean);
+    newLine(): void;
+    appendNoWrap(line: string): void;
+    append(line: string): void;
+    toString(): string;
+}
+
 export declare interface Filter {
     code: string;
     operator: Operator;
@@ -1487,6 +1504,13 @@ export declare function formatQuantity(quantity: Quantity | undefined, precision
  */
 export declare function formatRange(range: Range_2 | undefined, precision?: number, exclusive?: boolean): string;
 
+/**
+ * Formats a FHIR Reference as a string.
+ * @param value - The reference to format.
+ * @returns The formatted reference string.
+ */
+export declare function formatReferenceString(value: Reference | undefined): string;
+
 /**
  * Formats a search definition object into a query string.
  * Note: The return value does not include the resource type.
@@ -1778,8 +1802,6 @@ 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.
  */
@@ -2735,6 +2757,8 @@ export declare function matchesSearchRequest(resource: Resource, searchRequest:
 
 export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
 
+export declare const MEDPLUM_RELEASES_URL = "https://meta.medplum.com/releases";
+
 export declare const MEDPLUM_VERSION: string;
 
 /**
@@ -3850,6 +3874,14 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @category Authentication
      */
     getAccessToken(): string | undefined;
+    /**
+     * Returns whether the client has a valid access token or not.
+     * @param gracePeriod - Optional grace period in milliseconds. If not specified, uses the client configured grace period (default 5 minutes).
+     * @returns Boolean indicating whether or not the client is authenticated.
+     *
+     * **NOTE: Does not check whether the auth token has been revoked server-side.**
+     */
+    isAuthenticated(gracePeriod?: number): boolean;
     /**
      * Sets the current access token.
      * @param accessToken - The new access token.
@@ -4524,7 +4556,6 @@ export declare interface MedplumClientOptions {
     /**
      * Default headers to include in all requests.
      * This can be used to set custom headers such as Cookies or Authorization headers.
-     * @default {}
      */
     defaultHeaders?: Record<string, string>;
 }
@@ -5591,7 +5622,6 @@ export declare const RXNORM = "http://www.nlm.nih.gov/research/umls/rxnorm";
 export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;
 
 export declare interface SearchParameterDetails {
-    readonly columnName: string;
     readonly type: SearchParameterType;
     readonly elementDefinitions?: InternalSchemaElement[];
     readonly array?: boolean;
@@ -6043,6 +6073,13 @@ export declare interface TypedValue {
     readonly value: any;
 }
 
+/**
+ * Converts a typed value to a string.
+ * @param typedValue - The typed value to convert to a string.
+ * @returns The string representation of the typed value.
+ */
+export declare function typedValueToString(typedValue: TypedValue | undefined): string;
+
 export declare type TypedValueWithPath = TypedValue & {
     path: string;
 };
@@ -6158,6 +6195,13 @@ export declare interface ValueSetExpandParams {
     count?: number;
 }
 
+/**
+ * Checks if a newer version of Medplum is available and logs a warning if so.
+ * @param appName - The name of the app to check the version for.
+ * @param params - An optional list of key-value pairs to be appended to the URL query string.
+ */
+export declare function warnIfNewerVersionAvailable(appName: string, params?: Record<string, string>): Promise<void>;
+
 declare type WebSocketEventMap_2 = {
     close: CloseEvent_2;
     error: ErrorEvent_2;
@@ -6166,6 +6210,15 @@ declare type WebSocketEventMap_2 = {
 };
 export { WebSocketEventMap_2 as WebSocketEventMap }
 
+/**
+ * Returns a word-wrapped string.
+ * Based on: https://stackoverflow.com/a/38709683
+ * @param text - Original input string.
+ * @param maxLength - Width in number of characters.
+ * @returns Array of lines.
+ */
+export declare function wordWrap(text: string, maxLength: number): string[];
+
 /**
  * 6.5.4. xor
  * Returns true if exactly one of the operands evaluates to true,

package/dist/esm/index.d.ts

@@ -417,10 +417,11 @@ export declare function checkForNull(value: unknown, path: string, issues: Opera
 
 /**
  * Tests that a given version string is a valid existing Medplum release version.
+ * @param appName - The name of the app to check the version for.
  * @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>;
+export declare function checkIfValidMedplumVersion(appName: string, version: string): Promise<boolean>;
 
 /**
  * Clears the locally-cached `ReleaseManifest`s for all versions.
@@ -962,17 +963,22 @@ export declare const ExternalSecretSystems: {
 };
 
 /**
+ * Fetches the latest Medplum release version string.
+ * @param appName - The name of the app to fetch the latest version for.
  * @returns A version string corresponding to the latest Medplum release version.
  */
-export declare function fetchLatestVersionString(): Promise<string>;
+export declare function fetchLatestVersionString(appName: string): Promise<string>;
 
 export declare type FetchLike = (url: string, options?: any) => Promise<any>;
 
 /**
+ * Fetches the manifest for a given Medplum release version.
+ * @param appName - The name of the app to fetch the manifest for.
  * @param version - The version to fetch. If no `version` is provided, defaults to the `latest` version.
+ * @param params - An optional list of key-value pairs to be appended to the URL query string.
  * @returns - The manifest for the specified or latest version.
  */
-export declare function fetchVersionManifest(version?: string): Promise<ReleaseManifest>;
+export declare function fetchVersionManifest(appName: string, version?: string, params?: Record<string, string>): Promise<ReleaseManifest>;
 
 export declare const FHIRCAST_EVENT_NAMES: {
     readonly 'Patient-open': "Patient-open";
@@ -1342,6 +1348,17 @@ export declare const fhirTypeToJsType: {
     readonly 'http://hl7.org/fhirpath/System.String': "string";
 };
 
+export declare class FileBuilder {
+    private readonly indent;
+    private readonly b;
+    indentCount: number;
+    constructor(indent?: string, header?: boolean);
+    newLine(): void;
+    appendNoWrap(line: string): void;
+    append(line: string): void;
+    toString(): string;
+}
+
 export declare interface Filter {
     code: string;
     operator: Operator;
@@ -1487,6 +1504,13 @@ export declare function formatQuantity(quantity: Quantity | undefined, precision
  */
 export declare function formatRange(range: Range_2 | undefined, precision?: number, exclusive?: boolean): string;
 
+/**
+ * Formats a FHIR Reference as a string.
+ * @param value - The reference to format.
+ * @returns The formatted reference string.
+ */
+export declare function formatReferenceString(value: Reference | undefined): string;
+
 /**
  * Formats a search definition object into a query string.
  * Note: The return value does not include the resource type.
@@ -1778,8 +1802,6 @@ 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.
  */
@@ -2735,6 +2757,8 @@ export declare function matchesSearchRequest(resource: Resource, searchRequest:
 
 export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
 
+export declare const MEDPLUM_RELEASES_URL = "https://meta.medplum.com/releases";
+
 export declare const MEDPLUM_VERSION: string;
 
 /**
@@ -3850,6 +3874,14 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @category Authentication
      */
     getAccessToken(): string | undefined;
+    /**
+     * Returns whether the client has a valid access token or not.
+     * @param gracePeriod - Optional grace period in milliseconds. If not specified, uses the client configured grace period (default 5 minutes).
+     * @returns Boolean indicating whether or not the client is authenticated.
+     *
+     * **NOTE: Does not check whether the auth token has been revoked server-side.**
+     */
+    isAuthenticated(gracePeriod?: number): boolean;
     /**
      * Sets the current access token.
      * @param accessToken - The new access token.
@@ -4524,7 +4556,6 @@ export declare interface MedplumClientOptions {
     /**
      * Default headers to include in all requests.
      * This can be used to set custom headers such as Cookies or Authorization headers.
-     * @default {}
      */
     defaultHeaders?: Record<string, string>;
 }
@@ -5591,7 +5622,6 @@ export declare const RXNORM = "http://www.nlm.nih.gov/research/umls/rxnorm";
 export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;
 
 export declare interface SearchParameterDetails {
-    readonly columnName: string;
     readonly type: SearchParameterType;
     readonly elementDefinitions?: InternalSchemaElement[];
     readonly array?: boolean;
@@ -6043,6 +6073,13 @@ export declare interface TypedValue {
     readonly value: any;
 }
 
+/**
+ * Converts a typed value to a string.
+ * @param typedValue - The typed value to convert to a string.
+ * @returns The string representation of the typed value.
+ */
+export declare function typedValueToString(typedValue: TypedValue | undefined): string;
+
 export declare type TypedValueWithPath = TypedValue & {
     path: string;
 };
@@ -6158,6 +6195,13 @@ export declare interface ValueSetExpandParams {
     count?: number;
 }
 
+/**
+ * Checks if a newer version of Medplum is available and logs a warning if so.
+ * @param appName - The name of the app to check the version for.
+ * @param params - An optional list of key-value pairs to be appended to the URL query string.
+ */
+export declare function warnIfNewerVersionAvailable(appName: string, params?: Record<string, string>): Promise<void>;
+
 declare type WebSocketEventMap_2 = {
     close: CloseEvent_2;
     error: ErrorEvent_2;
@@ -6166,6 +6210,15 @@ declare type WebSocketEventMap_2 = {
 };
 export { WebSocketEventMap_2 as WebSocketEventMap }
 
+/**
+ * Returns a word-wrapped string.
+ * Based on: https://stackoverflow.com/a/38709683
+ * @param text - Original input string.
+ * @param maxLength - Width in number of characters.
+ * @returns Array of lines.
+ */
+export declare function wordWrap(text: string, maxLength: number): string[];
+
 /**
  * 6.5.4. xor
  * Returns true if exactly one of the operands evaluates to true,