@medplum/core 0.9.1 → 0.9.4

package/dist/types/cache.d.ts

@@ -8,4 +8,5 @@ export declare class LRUCache<T> {
     clear(): void;
     get(key: string): T | undefined;
     set(key: string, val: T): void;
+    delete(key: string): void;
 }

package/dist/types/client.d.ts

@@ -1,6 +1,8 @@
 import { Binary, Bundle, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
 import type { Operation } from 'fast-json-patch';
 import { EventTarget } from './eventtarget';
+import { Hl7Message } from './hl7';
+import { ReadablePromise } from './readablepromise';
 import { SearchRequest } from './search';
 import { IndexedStructureDefinition } from './types';
 import { ProfileResource } from './utils';
@@ -98,6 +100,10 @@ export interface TokenResponse {
     readonly project: Reference<Project>;
     readonly profile: Reference<ProfileResource>;
 }
+export interface BotEvent {
+    readonly contentType: string;
+    readonly input: Resource | Hl7Message | string;
+}
 /**
  * The MedplumClient class provides a client for the Medplum FHIR server.
  *
@@ -164,7 +170,7 @@ export declare class MedplumClient extends EventTarget {
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
-    get(url: string, options?: RequestInit): Promise<any>;
+    get<T = any>(url: string, options?: RequestInit): ReadablePromise<T>;
     /**
      * Makes an HTTP POST request to the specified URL.
      *
@@ -396,7 +402,7 @@ export declare class MedplumClient extends EventTarget {
      * @param id The resource ID.
      * @returns The resource if available; undefined otherwise.
      */
-    readResource<T extends Resource>(resourceType: string, id: string): Promise<T>;
+    readResource<T extends Resource>(resourceType: string, id: string): ReadablePromise<T>;
     /**
      * Reads a resource by resource type and ID using the in-memory resource cache.
      *
@@ -415,7 +421,7 @@ export declare class MedplumClient extends EventTarget {
      * @param id The resource ID.
      * @returns The resource if available; undefined otherwise.
      */
-    readCached<T extends Resource>(resourceType: string, id: string): Promise<T>;
+    readCached<T extends Resource>(resourceType: string, id: string): ReadablePromise<T>;
     /**
      * Reads a resource by `Reference`.
      *
@@ -434,7 +440,7 @@ export declare class MedplumClient extends EventTarget {
      * @param reference The FHIR reference object.
      * @returns The resource if available; undefined otherwise.
      */
-    readReference<T extends Resource>(reference: Reference<T>): Promise<T>;
+    readReference<T extends Resource>(reference: Reference<T>): ReadablePromise<T>;
     /**
      * Reads a resource by `Reference` using the in-memory resource cache.
      *
@@ -455,7 +461,7 @@ export declare class MedplumClient extends EventTarget {
      * @param reference The FHIR reference object.
      * @returns The resource if available; undefined otherwise.
      */
-    readCachedReference<T extends Resource>(reference: Reference<T>): Promise<T>;
+    readCachedReference<T extends Resource>(reference: Reference<T>): ReadablePromise<T>;
     /**
      * Returns a cached schema for a resource type.
      * If the schema is not cached, returns undefined.
@@ -532,6 +538,45 @@ export declare class MedplumClient extends EventTarget {
      * @returns The result of the create operation.
      */
     createResource<T extends Resource>(resource: T): Promise<T>;
+    /**
+     * Conditionally create a new FHIR resource only if some equivalent resource does not already exist on the server.
+     *
+     * The return value is the existing resource or the newly created resource, including the ID and meta.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createResourceIfNoneExist(
+     *   'Patient?identifier=123',
+     *   {
+     *     resourceType: 'Patient',
+     *     identifier: [{
+     *      system: 'http://example.com/mrn',
+     *      value: '123'
+     *     }]
+     *     name: [{
+     *      family: 'Smith',
+     *      given: ['John']
+     *     }]
+     *   });
+     * console.log(result.id);
+     * ```
+     *
+     * This method is syntactic sugar for:
+     *
+     * ```typescript
+     * return searchOne(query) ?? createResource(resource);
+     * ```
+     *
+     * The query parameter only contains the search parameters (what would be in the URL following the "?").
+     *
+     * See the FHIR "conditional create" operation for full details: https://www.hl7.org/fhir/http.html#ccreate
+     *
+     * @param resource The FHIR resource to create.
+     * @param query The search query for an equivalent resource.
+     * @returns The result of the create operation.
+     */
+    createResourceIfNoneExist<T extends Resource>(resource: T, query: string): Promise<T>;
     /**
      * Creates a FHIR `Binary` resource with the provided data content.
      *
@@ -550,10 +595,34 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
      *
-     * @param resource The FHIR resource to create.
+     * @param data The binary data to upload.
+     * @param filename Optional filename for the binary.
+     * @param contentType Content type for the binary.
+     * @returns The result of the create operation.
+     */
+    createBinary(data: string | File, filename: string | undefined, contentType: string): Promise<Binary>;
+    /**
+     * Creates a PDF as a FHIR `Binary` resource based on pdfmake document definition.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * The `docDefinition` parameter is a pdfmake document definition.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createPdf({
+     *   content: ['Hello world']
+     * });
+     * console.log(result.id);
+     * ```
+     *
+     * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
+     *
+     * @param docDefinition The FHIR resource to create.
      * @returns The result of the create operation.
      */
-    createBinary(data: any, filename: string, contentType: string): Promise<Binary>;
+    createPdf(docDefinition: Record<string, unknown>, filename?: string): Promise<Binary>;
     /**
      * Updates a FHIR resource.
      *

package/dist/types/index.d.ts

@@ -1,8 +1,9 @@
+export * from './cache';
 export * from './client';
 export * from './format';
 export * from './hl7';
 export * from './outcomes';
-export * from './repo';
+export * from './readablepromise';
 export * from './search';
 export * from './searchparams';
 export * from './types';

package/dist/types/readablepromise.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The ReadablePromise class wraps a request promise suitable for React Suspense.
+ * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js
+ * See: https://github.com/ovieokeh/suspense-data-fetching/blob/master/lib/api/wrapPromise.js
+ */
+export declare class ReadablePromise<T> implements Promise<T> {
+    #private;
+    readonly [Symbol.toStringTag]: string;
+    constructor(requestPromise: Promise<T>);
+    /**
+     * Returns true if the promise is pending.
+     * @returns True if the Promise is pending.
+     */
+    isPending(): boolean;
+    /**
+     * Attempts to read the value of the promise.
+     * If the promise is pending, this method will throw a promise.
+     * If the promise rejected, this method will throw the rejection reason.
+     * If the promise resolved, this method will return the resolved value.
+     * @returns The resolved value of the Promise.
+     */
+    read(): T;
+    /**
+     * Attaches callbacks for the resolution and/or rejection of the Promise.
+     * @param onfulfilled The callback to execute when the Promise is resolved.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @returns A Promise for the completion of which ever callback is executed.
+     */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    /**
+     * Attaches a callback for only the rejection of the Promise.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @returns A Promise for the completion of the callback.
+     */
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
+    /**
+     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+     * resolved value cannot be modified from the callback.
+     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
+     * @returns A Promise for the completion of the callback.
+     */
+    finally(onfinally?: (() => void) | undefined | null): Promise<T>;
+}

package/dist/types/search.d.ts

@@ -1,8 +1,9 @@
+export declare const DEFAULT_SEARCH_COUNT = 20;
 export interface SearchRequest {
     readonly resourceType: string;
     filters?: Filter[];
     sortRules?: SortRule[];
-    page?: number;
+    offset?: number;
     count?: number;
     fields?: string[];
     name?: string;

package/dist/types/utils.d.ts

@@ -91,18 +91,23 @@ export declare function stringify(value: any, pretty?: boolean): string;
 /**
  * Resource equality.
  * Ignores meta.versionId and meta.lastUpdated.
- * See: https://dmitripavlutin.com/how-to-compare-objects-in-javascript/#4-deep-equality
  * @param object1 The first object.
  * @param object2 The second object.
  * @returns True if the objects are equal.
  */
-export declare function deepEquals(object1: any, object2: any, path?: string): boolean;
+export declare function deepEquals(object1: unknown, object2: unknown, path?: string): boolean;
+/**
+ * Returns true if the input string is a UUID.
+ * @param input The input string.
+ * @returns True if the input string matches the UUID format.
+ */
+export declare function isUUID(input: string): boolean;
 /**
  * Returns true if the input is an object.
  * @param object The candidate object.
  * @returns True if the input is a non-null non-undefined object.
  */
-export declare function isObject(obj: unknown): obj is object;
+export declare function isObject(obj: unknown): obj is Record<string, unknown>;
 /**
  * Returns true if the input array is an array of strings.
  * @param arr Input array.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "0.9.1",
+  "version": "0.9.4",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",
@@ -17,7 +17,7 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@medplum/fhirtypes": "0.9.1",
+    "@medplum/fhirtypes": "0.9.4",
     "fast-json-patch": "3.1.1"
   },
   "main": "dist/cjs/index.js",

package/dist/types/repo.d.ts

@@ -1,116 +0,0 @@
-import { Bundle, OperationOutcome, Reference, Resource } from '@medplum/fhirtypes';
-import { Operation } from 'fast-json-patch';
-import { MedplumClient } from './client';
-import { SearchRequest } from './search';
-/**
- * The LegacyRepositoryResult type is a tuple of operation outcome and optional resource.
- * @deprecated
- */
-export declare type LegacyRepositoryResult<T extends Resource | undefined> = Promise<[OperationOutcome, T | undefined]>;
-/**
- * The LegacyRepositoryClient is a supplementary API client that matches the legacy "Repository" API.
- * The "Repository" API is deprecated and will be removed in a future release.
- * This LegacyRepositoryClient is also deprecated and will be removed in a future release.
- * @deprecated
- */
-export declare class LegacyRepositoryClient {
-    #private;
-    constructor(client: MedplumClient);
-    /**
-     * Creates a resource.
-     *
-     * See: https://www.hl7.org/fhir/http.html#create
-     *
-     * @param resource The resource to create.
-     * @returns Operation outcome and the new resource.
-     * @deprecated
-     */
-    createResource<T extends Resource>(resource: T): LegacyRepositoryResult<T>;
-    /**
-     * Returns a resource.
-     *
-     * See: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
-     * @returns Operation outcome and a resource.
-     * @deprecated
-     */
-    readResource<T extends Resource>(resourceType: string, id: string): LegacyRepositoryResult<T>;
-    /**
-     * Returns a resource by FHIR reference.
-     *
-     * See: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param reference The FHIR reference.
-     * @returns Operation outcome and a resource.
-     * @deprecated
-     */
-    readReference<T extends Resource>(reference: Reference<T>): LegacyRepositoryResult<T>;
-    /**
-     * Returns resource history.
-     *
-     * See: https://www.hl7.org/fhir/http.html#history
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
-     * @returns Operation outcome and a history bundle.
-     * @deprecated
-     */
-    readHistory<T extends Resource>(resourceType: string, id: string): LegacyRepositoryResult<Bundle<T>>;
-    /**
-     * Returns a resource version.
-     *
-     * See: https://www.hl7.org/fhir/http.html#vread
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
-     * @param vid The version ID.
-     * @returns Operation outcome and a resource.
-     * @deprecated
-     */
-    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): LegacyRepositoryResult<T>;
-    /**
-     * Updates a resource.
-     *
-     * See: https://www.hl7.org/fhir/http.html#update
-     *
-     * @param resource The resource to update.
-     * @returns Operation outcome and the updated resource.
-     * @deprecated
-     */
-    updateResource<T extends Resource>(resource: T): LegacyRepositoryResult<T>;
-    /**
-     * Deletes a resource.
-     *
-     * See: https://www.hl7.org/fhir/http.html#delete
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns Operation outcome.
-     * @deprecated
-     */
-    deleteResource(resourceType: string, id: string): LegacyRepositoryResult<undefined>;
-    /**
-     * Patches a resource.
-     *
-     * See: https://www.hl7.org/fhir/http.html#patch
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @param patch Array of JSONPatch operations.
-     * @returns Operation outcome and the resource.
-     * @deprecated
-     */
-    patchResource(resourceType: string, id: string, patch: Operation[]): LegacyRepositoryResult<Resource>;
-    /**
-     * Searches for resources.
-     *
-     * See: https://www.hl7.org/fhir/http.html#search
-     *
-     * @param searchRequest The search request.
-     * @returns The search result bundle.
-     * @deprecated
-     */
-    search<T extends Resource>(query: SearchRequest | string): LegacyRepositoryResult<Bundle<T>>;
-}