@medplum/core 0.9.6 → 0.9.7

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

package/dist/types/client.d.ts

@@ -1,58 +1,75 @@
-import { Binary, Bundle, OperationOutcome, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
-import type { Operation } from 'fast-json-patch';
-import type Mail from 'nodemailer/lib/mailer';
+import { Binary, Bundle, Communication, OperationOutcome, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
 import { EventTarget } from './eventtarget';
 import { Hl7Message } from './hl7';
 import { ReadablePromise } from './readablepromise';
 import { SearchRequest } from './search';
 import { IndexedStructureDefinition } from './types';
 import { ProfileResource } from './utils';
+/**
+ * The MedplumClientOptions interface defines configuration options for MedplumClient.
+ *
+ * All configuration settings are optional.
+ */
 export interface MedplumClientOptions {
-    /**
-     * The client ID.
-     * Optional.  Default is to defer to the server to use the default client.
-     * Use this to use a specific client for SMART-on-FHIR.
-     */
-    clientId?: string;
     /**
      * Base server URL.
-     * Optional.  Default value is "https://api.medplum.com/".
+     *
+     * Default value is "https://api.medplum.com/".
+     *
      * Use this to point to a custom Medplum deployment.
      */
     baseUrl?: string;
     /**
      * OAuth2 authorize URL.
-     * Optional.  Default value is baseUrl + "/oauth2/authorize".
+     *
+     * Default value is baseUrl + "/oauth2/authorize".
+     *
      * Use this if you want to use a separate OAuth server.
      */
     authorizeUrl?: string;
     /**
      * OAuth2 token URL.
-     * Optional.  Default value is baseUrl + "/oauth2/token".
+     *
+     * Default value is baseUrl + "/oauth2/token".
+     *
      * Use this if you want to use a separate OAuth server.
      */
     tokenUrl?: string;
     /**
      * OAuth2 logout URL.
-     * Optional.  Default value is baseUrl + "/oauth2/logout".
+     *
+     * Default value is baseUrl + "/oauth2/logout".
+     *
      * Use this if you want to use a separate OAuth server.
      */
     logoutUrl?: string;
+    /**
+     * The client ID.
+     *
+     * Client ID can be used for SMART-on-FHIR customization.
+     */
+    clientId?: string;
     /**
      * Number of resources to store in the cache.
-     * Optional.  Default value is 1000.
+     *
+     * Default value is 1000.
+     *
      * Consider using this for performance of displaying Patient or Practitioner resources.
      */
     resourceCacheSize?: number;
     /**
-     * Optional fetch implementation.
-     * Optional.  Default is window.fetch.
+     * Fetch implementation.
+     *
+     * Default is window.fetch (if available).
+     *
      * For nodejs applications, consider the 'node-fetch' package.
      */
     fetch?: FetchLike;
     /**
-     * Optional callback for when the client is unauthenticated.
+     * Callback for when the client is unauthenticated.
+     *
      * Default is do nothing.
+     *
      * For client side applications, consider redirecting to a sign in page.
      */
     onUnauthenticated?: () => void;
@@ -111,6 +128,63 @@ export interface BotEvent {
     readonly contentType: string;
     readonly input: Resource | Hl7Message | string;
 }
+/**
+ * JSONPatch patch operation.
+ * Compatible with fast-json-patch Operation.
+ */
+export interface PatchOperation {
+    readonly op: string;
+    readonly path: string;
+    readonly value?: any;
+}
+/**
+ * Email address definition.
+ * Compatible with nodemailer Mail.Address.
+ */
+export interface MailAddress {
+    readonly name: string;
+    readonly address: string;
+}
+/**
+ * Email attachment definition.
+ * Compatible with nodemailer Mail.Options.
+ */
+export interface MailAttachment {
+    /** String, Buffer or a Stream contents for the attachmentent */
+    readonly content?: string;
+    /** path to a file or an URL (data uris are allowed as well) if you want to stream the file instead of including it (better for larger attachments) */
+    readonly path?: string;
+    /** filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value as false, otherwise a filename is generated automatically */
+    readonly filename?: string | false;
+    /** optional content type for the attachment, if not set will be derived from the filename property */
+    readonly contentType?: string;
+}
+/**
+ * Email message definition.
+ * Compatible with nodemailer Mail.Options.
+ */
+export interface MailOptions {
+    /** The e-mail address of the sender. All e-mail addresses can be plain 'sender@server.com' or formatted 'Sender Name <sender@server.com>' */
+    readonly from?: string | MailAddress;
+    /** An e-mail address that will appear on the Sender: field */
+    readonly sender?: string | MailAddress;
+    /** Comma separated list or an array of recipients e-mail addresses that will appear on the To: field */
+    readonly to?: string | MailAddress | string[] | MailAddress[];
+    /** Comma separated list or an array of recipients e-mail addresses that will appear on the Cc: field */
+    readonly cc?: string | MailAddress | string[] | MailAddress[];
+    /** Comma separated list or an array of recipients e-mail addresses that will appear on the Bcc: field */
+    readonly bcc?: string | MailAddress | string[] | MailAddress[];
+    /** An e-mail address that will appear on the Reply-To: field */
+    readonly replyTo?: string | MailAddress;
+    /** The subject of the e-mail */
+    readonly subject?: string;
+    /** The plaintext version of the message */
+    readonly text?: string;
+    /** The HTML version of the message */
+    readonly html?: string;
+    /** An array of attachment objects */
+    readonly attachments?: MailAttachment[];
+}
 /**
  * The MedplumClient class provides a client for the Medplum FHIR server.
  *
@@ -157,11 +231,17 @@ export interface BotEvent {
  * const bundle = await medplum.search('Patient?name=Alice');
  * console.log(bundle.total);
  * ```
- *
  */
 export declare class MedplumClient extends EventTarget {
     #private;
     constructor(options?: MedplumClientOptions);
+    /**
+     * Returns the current base URL for all API requests.
+     * By default, this is set to `https://api.medplum.com/`.
+     * This can be overridden by setting the `baseUrl` option when creating the client.
+     * @returns The current base URL for all API requests.
+     */
+    getBaseUrl(): string;
     /**
      * Clears all auth state including local storage and session storage.
      */
@@ -177,7 +257,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    get<T = any>(url: string, options?: RequestInit): ReadablePromise<T>;
+    get<T = any>(url: URL | string, options?: RequestInit): ReadablePromise<T>;
     /**
      * Makes an HTTP POST request to the specified URL.
      *
@@ -191,7 +271,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    post(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
+    post(url: URL | string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
     /**
      * Makes an HTTP PUT request to the specified URL.
      *
@@ -205,7 +285,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    put(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
+    put(url: URL | string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
     /**
      * Makes an HTTP PATCH request to the specified URL.
      *
@@ -218,7 +298,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    patch(url: string, operations: Operation[], options?: RequestInit): Promise<any>;
+    patch(url: URL | string, operations: PatchOperation[], options?: RequestInit): Promise<any>;
     /**
      * Makes an HTTP DELETE request to the specified URL.
      *
@@ -230,7 +310,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    delete(url: string, options?: RequestInit): Promise<any>;
+    delete(url: URL | string, options?: RequestInit): Promise<any>;
     /**
      * Tries to register a new user.
      * @param request The registration request.
@@ -273,7 +353,7 @@ export declare class MedplumClient extends EventTarget {
      * @param path The path component of the URL.
      * @returns The well-formed FHIR URL.
      */
-    fhirUrl(...path: string[]): string;
+    fhirUrl(...path: string[]): URL;
     /**
      * Sends a FHIR search request.
      *
@@ -328,7 +408,7 @@ export declare class MedplumClient extends EventTarget {
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
-    search<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<Bundle<T>>;
+    search<T extends Resource>(query: string | SearchRequest, options?: RequestInit): ReadablePromise<Bundle<T>>;
     /**
      * Sends a FHIR search request for a single resource.
      *
@@ -348,7 +428,7 @@ export declare class MedplumClient extends EventTarget {
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
-    searchOne<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T | undefined>;
+    searchOne<T extends Resource>(query: string | SearchRequest, options?: RequestInit): ReadablePromise<T | undefined>;
     /**
      * Sends a FHIR search request for an array of resources.
      *
@@ -368,7 +448,7 @@ export declare class MedplumClient extends EventTarget {
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
-    searchResources<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T[]>;
+    searchResources<T extends Resource>(query: string | SearchRequest, options?: RequestInit): ReadablePromise<T[]>;
     /**
      * Searches a ValueSet resource using the "expand" operation.
      * See: https://www.hl7.org/fhir/operation-valueset-expand.html
@@ -376,7 +456,7 @@ export declare class MedplumClient extends EventTarget {
      * @param filter The search string.
      * @returns Promise to expanded ValueSet.
      */
-    searchValueSet(system: string, filter: string, options?: RequestInit): Promise<ValueSet>;
+    searchValueSet(system: string, filter: string, options?: RequestInit): ReadablePromise<ValueSet>;
     /**
      * Returns a cached resource if it is available.
      * @param resourceType The FHIR resource type.
@@ -498,9 +578,9 @@ export declare class MedplumClient extends EventTarget {
      *
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
-     * @returns The resource if available; undefined otherwise.
+     * @returns Promise to the resource history.
      */
-    readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
+    readHistory<T extends Resource>(resourceType: string, id: string): ReadablePromise<Bundle<T>>;
     /**
      * Reads a specific version of a resource by resource type, ID, and version ID.
      *
@@ -517,8 +597,8 @@ export declare class MedplumClient extends EventTarget {
      * @param id The resource ID.
      * @returns The resource if available; undefined otherwise.
      */
-    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>;
-    readPatientEverything(id: string): Promise<Bundle>;
+    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): ReadablePromise<T>;
+    readPatientEverything(id: string): ReadablePromise<Bundle>;
     /**
      * Creates a new FHIR resource.
      *
@@ -628,6 +708,16 @@ export declare class MedplumClient extends EventTarget {
      * @returns The result of the create operation.
      */
     createPdf(docDefinition: Record<string, unknown>, filename?: string): Promise<Binary>;
+    /**
+     * Creates a FHIR `Communication` resource with the provided data content.
+     *
+     * This is a convenience method to handle commmon cases where a `Communication` resource is created with a `payload`.
+     *
+     * @param resource The FHIR resource to comment on.
+     * @param text The text of the comment.
+     * @returns The result of the create operation.
+     */
+    createComment(resource: Resource, text: string): Promise<Communication>;
     /**
      * Updates a FHIR resource.
      *
@@ -676,7 +766,7 @@ export declare class MedplumClient extends EventTarget {
      * @param operations The JSONPatch operations.
      * @returns The result of the patch operations.
      */
-    patchResource<T extends Resource>(resourceType: string, id: string, operations: Operation[]): Promise<T>;
+    patchResource<T extends Resource>(resourceType: string, id: string, operations: PatchOperation[]): Promise<T>;
     /**
      * Deletes a FHIR resource by resource type and ID.
      *
@@ -730,10 +820,11 @@ export declare class MedplumClient extends EventTarget {
      * @param options The MailComposer options.
      * @returns Promise to the operation outcome.
      */
-    sendEmail(email: Mail.Options): Promise<OperationOutcome>;
+    sendEmail(email: MailOptions): Promise<OperationOutcome>;
     graphql(query: string, options?: RequestInit): Promise<any>;
     getActiveLogin(): LoginState | undefined;
     setActiveLogin(login: LoginState): Promise<void>;
+    getAccessToken(): string | undefined;
     setAccessToken(accessToken: string): void;
     getLogins(): LoginState[];
     isLoading(): boolean;
@@ -745,12 +836,19 @@ export declare class MedplumClient extends EventTarget {
      * @param url The URL to request.
      * @returns Promise to the response body as a blob.
      */
-    download(url: string, options?: RequestInit): Promise<Blob>;
+    download(url: URL | string, options?: RequestInit): Promise<Blob>;
     /**
      * Processes an OAuth authorization code.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenRequest
      * @param code The authorization code received by URL parameter.
      */
     processCode(code: string): Promise<ProfileResource>;
-    clientCredentials(clientId: string, clientSecret: string): Promise<ProfileResource>;
+    /**
+     * Starts a new OAuth2 client credentials flow.
+     * See: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
+     * @param clientId The client ID.
+     * @param clientSecret The client secret.
+     * @returns Promise that resolves to the client profile.
+     */
+    startClientLogin(clientId: string, clientSecret: string): Promise<ProfileResource>;
 }

package/dist/types/fhirpath/atoms.d.ts

@@ -0,0 +1,150 @@
+import { Quantity } from '@medplum/fhirtypes';
+export interface Atom {
+    eval(context: unknown): unknown;
+}
+export declare class FhirPathAtom implements Atom {
+    readonly original: string;
+    readonly child: Atom;
+    constructor(original: string, child: Atom);
+    eval(context: unknown): unknown[];
+}
+export declare class LiteralAtom implements Atom {
+    readonly value: Quantity | boolean | number | string;
+    constructor(value: Quantity | boolean | number | string);
+    eval(): unknown;
+}
+export declare class SymbolAtom implements Atom {
+    readonly name: string;
+    constructor(name: string);
+    eval(context: unknown): unknown;
+}
+export declare class EmptySetAtom implements Atom {
+    eval(): [];
+}
+export declare class UnaryOperatorAtom implements Atom {
+    readonly child: Atom;
+    readonly impl: (x: unknown) => unknown;
+    constructor(child: Atom, impl: (x: unknown) => unknown);
+    eval(context: unknown): unknown;
+}
+export declare class AsAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class ArithemticOperatorAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    readonly impl: (x: number, y: number) => number;
+    constructor(left: Atom, right: Atom, impl: (x: number, y: number) => number);
+    eval(context: unknown): unknown;
+}
+export declare class ComparisonOperatorAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    readonly impl: (x: number, y: number) => boolean;
+    constructor(left: Atom, right: Atom, impl: (x: number, y: number) => boolean);
+    eval(context: unknown): unknown;
+}
+export declare class ConcatAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class ContainsAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class InAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class DotAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class UnionAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class EqualsAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class NotEqualsAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class EquivalentAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class NotEquivalentAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class IsAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+/**
+ * 6.5.1. and
+ * Returns true if both operands evaluate to true, false if either operand evaluates to false, and the empty collection ({ }) otherwise.
+ */
+export declare class AndAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class OrAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+/**
+ * 6.5.4. xor
+ * Returns true if exactly one of the operands evaluates to true,
+ * false if either both operands evaluate to true or both operands evaluate to false,
+ * and the empty collection ({ }) otherwise:
+ */
+export declare class XorAtom implements Atom {
+    readonly left: Atom;
+    readonly right: Atom;
+    constructor(left: Atom, right: Atom);
+    eval(context: unknown): unknown;
+}
+export declare class FunctionAtom implements Atom {
+    readonly name: string;
+    readonly args: Atom[];
+    readonly impl: (context: unknown[], ...a: Atom[]) => unknown[];
+    constructor(name: string, args: Atom[], impl: (context: unknown[], ...a: Atom[]) => unknown[]);
+    eval(context: unknown): unknown;
+}
+export declare class IndexerAtom implements Atom {
+    readonly left: Atom;
+    readonly expr: Atom;
+    constructor(left: Atom, expr: Atom);
+    eval(context: unknown): unknown;
+}

package/dist/types/fhirpath/date.d.ts

@@ -0,0 +1 @@
+export declare function parseDateString(str: string): string;