@medplum/core 2.1.11 → 2.1.13

package/dist/types.d.ts

@@ -375,6 +375,12 @@ export declare function createReference<T extends Resource>(resource: T): Refere
 
 export declare function createStructureIssue(expression: string, details: string): OperationOutcomeIssue;
 
+export declare type CurrentContext<EventName extends FhircastResourceEventName = FhircastResourceEventName> = {
+    'context.type': ResourceType | '';
+    'context.versionId'?: string;
+    context: FhircastEventContext<EventName>[];
+};
+
 /**
  * Decodes a base64 string.
  * Handles both browser and Node environments.
@@ -748,6 +754,8 @@ export declare type FhircastMultiResourceContext<EventName extends FhircastEvent
     resources: FhircastEventResource<EventName, K>[];
 };
 
+export declare type FhircastResourceEventName = Exclude<FhircastEventName, 'syncerror'>;
+
 export declare type FhircastResourceType = (typeof FHIRCAST_RESOURCE_TYPES)[number];
 
 export declare type FhircastSingleResourceContext<EventName extends FhircastEventName = FhircastEventName, K extends FhircastEventContextKey<EventName> = FhircastEventContextKey<EventName>> = {
@@ -1254,14 +1262,9 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
 /**
  * The Hl7Context class represents the parsing context for an HL7 message.
  *
- * MSH-1:
- * https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.1
- *
- * MSH-2:
- * https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.2
- *
- * See this tutorial on MSH, and why it's a bad idea to use anything other than the default values:
- * https://www.hl7soup.com/HL7TutorialMSH.html
+ * @see MSH-1: https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.1
+ * @see MSH-2: https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.2
+ * @see See this tutorial on MSH, and why it's a bad idea to use anything other than the default values: https://www.hl7soup.com/HL7TutorialMSH.html
  */
 export declare class Hl7Context {
     readonly segmentSeparator: string;
@@ -1536,9 +1539,7 @@ export declare interface IncludeTarget {
  *   PropertySchema - one per property/field
  */
 export declare interface IndexedStructureDefinition {
-    types: {
-        [resourceType: string]: TypeInfo;
-    };
+    types: Record<string, TypeInfo>;
 }
 
 export declare class IndexerAtom implements Atom {
@@ -1768,7 +1769,7 @@ export declare function isStringArray(arr: any[]): arr is string[];
  * @param input - The input string.
  * @returns True if the input string matches the UUID format.
  */
-export declare function isUUID(input: string): input is `${string}-${string}-${string}-${string}-${string}`;
+export declare function isUUID(input: string): input is string;
 
 /**
  * Returns true if the given date object is a valid date.
@@ -1939,7 +1940,7 @@ export declare function matchesRange(value: number, range: Range_2, precision?:
  */
 export declare function matchesSearchRequest(resource: Resource, searchRequest: SearchRequest): boolean;
 
-export declare const MEDPLUM_VERSION: string;
+export declare const MEDPLUM_VERSION: any;
 
 /**
  * The MedplumClient class provides a client for the Medplum FHIR server.
@@ -2232,9 +2233,10 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param clientId - The external client ID.
      * @param redirectUri - The external identity provider redirect URI.
      * @param baseLogin - The Medplum login request.
+     * @param pkceEnabled - Whether `PKCE` should be enabled for this external auth request. Defaults to `true`.
      * @category Authentication
      */
-    signInWithExternalAuth(authorizeUrl: string, clientId: string, redirectUri: string, baseLogin: BaseLoginRequest): Promise<void>;
+    signInWithExternalAuth(authorizeUrl: string, clientId: string, redirectUri: string, baseLogin: BaseLoginRequest, pkceEnabled?: boolean): Promise<void>;
     /**
      * Exchange an external access token for a Medplum access token.
      * @param token - The access token that was generated by the external identity provider.
@@ -2249,10 +2251,11 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param clientId - The external client ID.
      * @param redirectUri - The external identity provider redirect URI.
      * @param loginRequest - The Medplum login request.
+     * @param pkceEnabled - Whether `PKCE` should be enabled for this external auth request. Defaults to `true`.
      * @returns The external identity provider redirect URI.
      * @category Authentication
      */
-    getExternalAuthRedirectUri(authorizeUrl: string, clientId: string, redirectUri: string, loginRequest: BaseLoginRequest): string;
+    getExternalAuthRedirectUri(authorizeUrl: string, clientId: string, redirectUri: string, loginRequest: BaseLoginRequest, pkceEnabled?: boolean): string;
     /**
      * Builds a FHIR URL from a collection of URL path components.
      * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
@@ -3171,7 +3174,7 @@ export declare class MedplumClient extends EventTarget_2 {
      *
      * @example
      * ```typescript
-     * await medplum.startClientLogin(process.env.MEDPLUM_CLIENT_ID, process.env.MEDPLUM_CLIENT_SECRET)
+     * await medplum.startClientLogin(import.meta.env.MEDPLUM_CLIENT_ID, import.meta.env.MEDPLUM_CLIENT_SECRET)
      * // Example Search
      * await medplum.searchResources('Patient')
      * ```
@@ -3189,7 +3192,7 @@ export declare class MedplumClient extends EventTarget_2 {
      *
      * @example
      * ```typescript
-     * await medplum.startJwtBearerLogin(process.env.MEDPLUM_CLIENT_ID, process.env.MEDPLUM_JWT_BEARER_ASSERTION, 'openid profile');
+     * await medplum.startJwtBearerLogin(import.meta.env.MEDPLUM_CLIENT_ID, import.meta.env.MEDPLUM_JWT_BEARER_ASSERTION, 'openid profile');
      * // Example Search
      * await medplum.searchResources('Patient')
      * ```
@@ -3218,7 +3221,7 @@ export declare class MedplumClient extends EventTarget_2 {
      *
      * @example
      * ```typescript
-     * medplum.setBasicAuth(process.env.MEDPLUM_CLIENT_ID, process.env.MEDPLUM_CLIENT_SECRET);
+     * medplum.setBasicAuth(import.meta.env.MEDPLUM_CLIENT_ID, import.meta.env.MEDPLUM_CLIENT_SECRET);
      * // Example Search
      * await medplum.searchResources('Patient');
      * ```
@@ -3267,6 +3270,14 @@ export declare class MedplumClient extends EventTarget_2 {
      */
     fhircastPublish<EventName extends FhircastEventVersionOptional>(topic: string, event: EventName, context: FhircastEventContext<EventName> | FhircastEventContext<EventName>[], versionId?: never): Promise<void>;
     fhircastPublish<RequiredVersionEvent extends FhircastEventVersionRequired>(topic: string, event: RequiredVersionEvent, context: FhircastEventContext<RequiredVersionEvent> | FhircastEventContext<RequiredVersionEvent>[], versionId: string): Promise<void>;
+    /**
+     * Gets the current context of the given FHIRcast `topic`.
+     *
+     * @category FHIRcast
+     * @param topic - The topic to get the current context for. Usually a UUID.
+     * @returns A Promise which resolves to the `CurrentContext` for the given topic.
+     */
+    fhircastGetContext(topic: string): Promise<CurrentContext>;
     /**
      * Invite a user to a project.
      * @param projectId - The project ID.
@@ -3951,8 +3962,16 @@ export declare function parseSearchUrl<T extends Resource = Resource>(url: URL):
 export declare function parseStructureDefinition(sd: StructureDefinition): InternalTypeSchema;
 
 /**
- * Parses an extended FHIR search criteria string (i.e. application/x-fhir-query), evaluating
- * any embedded FHIRPath subexpressions (e.g. `{{ %patient.id }}`) with the provided variables.
+ * Parses an extended FHIR search criteria string (i.e. application/x-fhir-query).
+ *
+ * @example Evaluating a FHIRPath subexpression
+ *
+ * ```typescript
+ * const query = 'Patient?name={{ %patient.name }}';
+ * const variables = { patient: { name: 'John Doe' } };
+ * const request = parseXFhirQuery(query, variables);
+ * console.log(request.filters[0].value); // "John Doe"
+ * ```
  *
  * @see https://hl7.org/fhir/fhir-xquery.html
  * @param query - The X-Fhir-Query string to parse
@@ -4499,12 +4518,8 @@ export declare interface TypedValue {
  *   4) Patient_Link
  */
 export declare interface TypeInfo {
-    searchParams?: {
-        [code: string]: SearchParameter;
-    };
-    searchParamsDetails?: {
-        [code: string]: SearchParameterDetails;
-    };
+    searchParams?: Record<string, SearchParameter>;
+    searchParamsDetails?: Record<string, SearchParameterDetails>;
 }
 
 export declare type TypeName<T> = T extends string ? 'string' : T extends number ? 'number' : T extends boolean ? 'boolean' : T extends undefined ? 'undefined' : 'object';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "2.1.11",
+  "version": "2.1.13",
   "description": "Medplum TS/JS Library",
   "keywords": [
     "medplum",
@@ -25,6 +25,7 @@
   },
   "license": "Apache-2.0",
   "author": "Medplum <hello@medplum.com>",
+  "type": "module",
   "sideEffects": false,
   "exports": {
     "types": "./dist/types.d.ts",
@@ -44,6 +45,8 @@
   "devDependencies": {
     "@medplum/definitions": "*",
     "@medplum/fhirtypes": "*",
+    "@types/jest": "^29.5.5",
+    "jest": "^29.7.0",
     "jest-websocket-mock": "2.5.0"
   },
   "peerDependencies": {