@medplum/core 3.1.2 → 3.1.4

package/dist/cjs/index.d.ts

@@ -35,7 +35,7 @@ import { Practitioner } from '@medplum/fhirtypes';
 import { Project } from '@medplum/fhirtypes';
 import { ProjectMembership } from '@medplum/fhirtypes';
 import { ProjectMembershipAccess } from '@medplum/fhirtypes';
-import { ProjectSecret } from '@medplum/fhirtypes';
+import { ProjectSetting } from '@medplum/fhirtypes';
 import { Quantity } from '@medplum/fhirtypes';
 import { QuestionnaireResponse } from '@medplum/fhirtypes';
 import { QuestionnaireResponseItemAnswer } from '@medplum/fhirtypes';
@@ -108,6 +108,7 @@ export declare interface AgentHeartbeatRequest extends BaseAgentRequestMessage {
 
 export declare interface AgentHeartbeatResponse extends BaseAgentMessage {
     type: 'agent:heartbeat:response';
+    version: string;
 }
 
 export declare type AgentMessage = AgentError | AgentConnectRequest | AgentConnectResponse | AgentHeartbeatRequest | AgentHeartbeatResponse | AgentTransmitRequest | AgentTransmitResponse;
@@ -125,6 +126,7 @@ export declare interface AgentTransmitResponse extends BaseAgentMessage {
     channel?: string;
     remote: string;
     contentType: string;
+    statusCode?: number;
     body: string;
 }
 
@@ -265,7 +267,7 @@ export declare interface BotEvent<T = Resource | Hl7Message | string | Record<st
     readonly bot: Reference<Bot>;
     readonly contentType: string;
     readonly input: T;
-    readonly secrets: Record<string, ProjectSecret>;
+    readonly secrets: Record<string, ProjectSetting>;
     readonly traceId?: string;
 }
 
@@ -1441,6 +1443,14 @@ export declare function getPathDisplayName(path: string): string;
  */
 export declare function getPropertyDisplayName(propertyName: string): string;
 
+/**
+ * Converts the given `query` to a string.
+ *
+ * @param query - The query to convert. The type can be any member of `QueryTypes`.
+ * @returns The query as a string.
+ */
+export declare function getQueryString(query: QueryTypes): string;
+
 /**
  * Returns all questionnaire answers as a map by link ID.
  * @param response - The questionnaire response resource.
@@ -1529,6 +1539,13 @@ export declare function getTypedPropertyValueWithSchema(typedValue: TypedValue,
 
 export declare function getValueSliceName(value: any, slices: SliceDefinitionWithTypes[], discriminators: SliceDiscriminator[], profileUrl: string | undefined): string | undefined;
 
+/**
+ * Concatenates a given base URL and path, ensuring the URL has the appropriate `ws://` or `wss://` protocol instead of `http://` or `https://`.
+ *
+ * @param baseUrl - The base URL.
+ * @param path - The URL to concat. Can be relative or absolute.
+ * @returns The concatenated WebSocket URL.
+ */
 export declare function getWebSocketUrl(baseUrl: URL | string, path: string): string;
 
 /**
@@ -2168,6 +2185,34 @@ export declare function isUUID(input: string): input is string;
  */
 export declare function isValidDate(date: Date): boolean;
 
+/**
+ * Tests whether a given input is a valid hostname.
+ *
+ * __NOTE: Does not validate that the input is a valid domain name, only a valid hostname.__
+ *
+ * @param input - The input to test.
+ * @returns True if `input` is a valid hostname, otherwise returns false.
+ *
+ * ### Valid matches:
+ * - foo
+ * - foo.com
+ * - foo.bar.com
+ * - foo.org
+ * - foo.bar.co.uk
+ * - localhost
+ * - LOCALHOST
+ * - foo-bar-baz
+ * - foo_bar
+ * - foobar123
+ *
+ * ### Invalid matches:
+ * - foo.com/bar
+ * - https://foo.com
+ * - foo_-bar_-
+ * - foo | rm -rf /
+ */
+export declare function isValidHostname(input: string): boolean;
+
 /**
  * Memoizes the result of a parameterless function
  * @param fn - The function to be wrapped
@@ -2365,7 +2410,7 @@ export declare function matchesSearchRequest(resource: Resource, searchRequest:
 
 export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
 
-export declare const MEDPLUM_VERSION: any;
+export declare const MEDPLUM_VERSION: string;
 
 /**
  * The MedplumClient class provides a client for the Medplum FHIR server.
@@ -3054,6 +3099,15 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns The result of the create operation.
      */
     createResourceIfNoneExist<T extends Resource>(resource: T, query: string, options?: MedplumRequestOptions): Promise<T>;
+    /**
+     * Upsert a resource: update it in place if it exists, otherwise create it.  This is done in a single, transactional
+     * request to guarantee data consistency.
+     * @param resource - The resource to update or create.
+     * @param query - A FHIR search query to uniquely identify the resource if it already exists.
+     * @param options  - Optional fetch options.
+     * @returns The updated/created resource.
+     */
+    upsertResource<T extends Resource>(resource: T, query: QueryTypes, options?: MedplumRequestOptions): Promise<T>;
     /**
      * Creates a FHIR `Attachment` with the provided data content.
      *
@@ -4304,6 +4358,8 @@ export declare class MockAsyncClientStorage extends ClientStorage implements ICl
     get isInitialized(): boolean;
 }
 
+export declare const multipleMatches: OperationOutcome;
+
 export declare interface NewPatientRequest {
     readonly login: string;
     readonly projectId: string;
@@ -4819,7 +4875,7 @@ export declare const protectedResourceTypes: string[];
  * Web browsers and Node.js automatically coerce values to strings.
  * See: https://github.com/microsoft/TypeScript/issues/32951
  */
-export declare type QueryTypes = URLSearchParams | string[][] | Record<string, any> | string | undefined;
+export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
@@ -5391,6 +5447,8 @@ export declare class UnionAtom extends InfixOperatorAtom {
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
 }
 
+export declare const VALID_HOSTNAME_REGEX: RegExp;
+
 /**
  * Validates that a `SubscriptionRequest`.
  *

package/dist/esm/index.d.ts

@@ -35,7 +35,7 @@ import { Practitioner } from '@medplum/fhirtypes';
 import { Project } from '@medplum/fhirtypes';
 import { ProjectMembership } from '@medplum/fhirtypes';
 import { ProjectMembershipAccess } from '@medplum/fhirtypes';
-import { ProjectSecret } from '@medplum/fhirtypes';
+import { ProjectSetting } from '@medplum/fhirtypes';
 import { Quantity } from '@medplum/fhirtypes';
 import { QuestionnaireResponse } from '@medplum/fhirtypes';
 import { QuestionnaireResponseItemAnswer } from '@medplum/fhirtypes';
@@ -108,6 +108,7 @@ export declare interface AgentHeartbeatRequest extends BaseAgentRequestMessage {
 
 export declare interface AgentHeartbeatResponse extends BaseAgentMessage {
     type: 'agent:heartbeat:response';
+    version: string;
 }
 
 export declare type AgentMessage = AgentError | AgentConnectRequest | AgentConnectResponse | AgentHeartbeatRequest | AgentHeartbeatResponse | AgentTransmitRequest | AgentTransmitResponse;
@@ -125,6 +126,7 @@ export declare interface AgentTransmitResponse extends BaseAgentMessage {
     channel?: string;
     remote: string;
     contentType: string;
+    statusCode?: number;
     body: string;
 }
 
@@ -265,7 +267,7 @@ export declare interface BotEvent<T = Resource | Hl7Message | string | Record<st
     readonly bot: Reference<Bot>;
     readonly contentType: string;
     readonly input: T;
-    readonly secrets: Record<string, ProjectSecret>;
+    readonly secrets: Record<string, ProjectSetting>;
     readonly traceId?: string;
 }
 
@@ -1441,6 +1443,14 @@ export declare function getPathDisplayName(path: string): string;
  */
 export declare function getPropertyDisplayName(propertyName: string): string;
 
+/**
+ * Converts the given `query` to a string.
+ *
+ * @param query - The query to convert. The type can be any member of `QueryTypes`.
+ * @returns The query as a string.
+ */
+export declare function getQueryString(query: QueryTypes): string;
+
 /**
  * Returns all questionnaire answers as a map by link ID.
  * @param response - The questionnaire response resource.
@@ -1529,6 +1539,13 @@ export declare function getTypedPropertyValueWithSchema(typedValue: TypedValue,
 
 export declare function getValueSliceName(value: any, slices: SliceDefinitionWithTypes[], discriminators: SliceDiscriminator[], profileUrl: string | undefined): string | undefined;
 
+/**
+ * Concatenates a given base URL and path, ensuring the URL has the appropriate `ws://` or `wss://` protocol instead of `http://` or `https://`.
+ *
+ * @param baseUrl - The base URL.
+ * @param path - The URL to concat. Can be relative or absolute.
+ * @returns The concatenated WebSocket URL.
+ */
 export declare function getWebSocketUrl(baseUrl: URL | string, path: string): string;
 
 /**
@@ -2168,6 +2185,34 @@ export declare function isUUID(input: string): input is string;
  */
 export declare function isValidDate(date: Date): boolean;
 
+/**
+ * Tests whether a given input is a valid hostname.
+ *
+ * __NOTE: Does not validate that the input is a valid domain name, only a valid hostname.__
+ *
+ * @param input - The input to test.
+ * @returns True if `input` is a valid hostname, otherwise returns false.
+ *
+ * ### Valid matches:
+ * - foo
+ * - foo.com
+ * - foo.bar.com
+ * - foo.org
+ * - foo.bar.co.uk
+ * - localhost
+ * - LOCALHOST
+ * - foo-bar-baz
+ * - foo_bar
+ * - foobar123
+ *
+ * ### Invalid matches:
+ * - foo.com/bar
+ * - https://foo.com
+ * - foo_-bar_-
+ * - foo | rm -rf /
+ */
+export declare function isValidHostname(input: string): boolean;
+
 /**
  * Memoizes the result of a parameterless function
  * @param fn - The function to be wrapped
@@ -2365,7 +2410,7 @@ export declare function matchesSearchRequest(resource: Resource, searchRequest:
 
 export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
 
-export declare const MEDPLUM_VERSION: any;
+export declare const MEDPLUM_VERSION: string;
 
 /**
  * The MedplumClient class provides a client for the Medplum FHIR server.
@@ -3054,6 +3099,15 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns The result of the create operation.
      */
     createResourceIfNoneExist<T extends Resource>(resource: T, query: string, options?: MedplumRequestOptions): Promise<T>;
+    /**
+     * Upsert a resource: update it in place if it exists, otherwise create it.  This is done in a single, transactional
+     * request to guarantee data consistency.
+     * @param resource - The resource to update or create.
+     * @param query - A FHIR search query to uniquely identify the resource if it already exists.
+     * @param options  - Optional fetch options.
+     * @returns The updated/created resource.
+     */
+    upsertResource<T extends Resource>(resource: T, query: QueryTypes, options?: MedplumRequestOptions): Promise<T>;
     /**
      * Creates a FHIR `Attachment` with the provided data content.
      *
@@ -4304,6 +4358,8 @@ export declare class MockAsyncClientStorage extends ClientStorage implements ICl
     get isInitialized(): boolean;
 }
 
+export declare const multipleMatches: OperationOutcome;
+
 export declare interface NewPatientRequest {
     readonly login: string;
     readonly projectId: string;
@@ -4819,7 +4875,7 @@ export declare const protectedResourceTypes: string[];
  * Web browsers and Node.js automatically coerce values to strings.
  * See: https://github.com/microsoft/TypeScript/issues/32951
  */
-export declare type QueryTypes = URLSearchParams | string[][] | Record<string, any> | string | undefined;
+export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
@@ -5391,6 +5447,8 @@ export declare class UnionAtom extends InfixOperatorAtom {
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
 }
 
+export declare const VALID_HOSTNAME_REGEX: RegExp;
+
 /**
  * Validates that a `SubscriptionRequest`.
  *