@medplum/core 0.2.2 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # Medplum
 
-Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications.  Medplum includes a FHIR server, React component library, and developer app.
+Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications. Medplum includes a FHIR server, React component library, and developer app.
 
 # Medplum JS Client Library
 
@@ -8,11 +8,11 @@ The Medplum JS Client Library is a pure TypeScript library for calling a FHIR se
 
 ## Key Features
 
-* FHIR validation and operations
-* FHIR client to create, read, update, delete, patch, and search
-* WebSockets for realtime communication
-* Evaluation of [FhirPath](https://hl7.org/fhirpath/N1/index.html)
-* No external dependencies
+- FHIR validation and operations
+- FHIR client to create, read, update, delete, patch, and search
+- WebSockets for realtime communication
+- Evaluation of [FhirPath](https://hl7.org/fhirpath/N1/index.html)
+- No external dependencies
 
 ## Installation
 
@@ -26,8 +26,8 @@ npm install medplum
 import { MedplumClient } from '@medplum/core';
 
 const medplum = new MedplumClient({
-    baseUrl: 'https://www.example.com/fhir/R4/',
-    clientId: 'MY_CLIENT_ID'
+  baseUrl: 'https://www.example.com/fhir/R4/',
+  clientId: 'MY_CLIENT_ID',
 });
 ```
 
@@ -36,7 +36,7 @@ const medplum = new MedplumClient({
 Authenticate with a FHIR server via OAuth2 redirect:
 
 ```typescript
-medplum.signInWithRedirect().then(user => console.log(user));
+medplum.signInWithRedirect().then((user) => console.log(user));
 ```
 
 ## Authenticating with Medplum
@@ -51,7 +51,7 @@ Before you begin
 After that, you can use the `signIn()` method:
 
 ```typescript
-medplum.signIn(email, password, role, scope).then(user => console.log(user));
+medplum.signIn(email, password, role, scope).then((user) => console.log(user));
 ```
 
 ## Search
@@ -59,24 +59,28 @@ medplum.signIn(email, password, role, scope).then(user => console.log(user));
 Search for any resource using a [FHIR search](https://www.hl7.org/fhir/search.html) string:
 
 ```typescript
-medplum.search('Patient?given=eve').then(bundle => {
-  bundle.entry.forEach(entry => console.log(entry.resource));
+medplum.search('Patient?given=eve').then((bundle) => {
+  bundle.entry.forEach((entry) => console.log(entry.resource));
 });
 ```
 
 Search using a structured object:
 
 ```typescript
-medplum.search({
-  resourceType: 'Patient',
-  filters: [{
-    code: 'given',
-    operator: Operator.EQUALS,
-    value: 'eve'
-  }]
-}).then(bundle => {
-  bundle.entry.forEach(entry => console.log(entry.resource));
-});
+medplum
+  .search({
+    resourceType: 'Patient',
+    filters: [
+      {
+        code: 'given',
+        operator: Operator.EQUALS,
+        value: 'eve',
+      },
+    ],
+  })
+  .then((bundle) => {
+    bundle.entry.forEach((entry) => console.log(entry.resource));
+  });
 ```
 
 ## Create
@@ -87,11 +91,11 @@ Create a new resource:
 medplum.create({
   resourceType: 'Observation',
   subject: {
-    reference: 'Patient/123'
+    reference: 'Patient/123',
   },
   valueQuantity: {
     // ...
-  }
+  },
   // ...
 });
 ```
@@ -118,4 +122,4 @@ medplum.readVersion('Patient', '123', '456');
 
 ## License
 
-Apache 2.0.  Copyright © Medplum 2021
+Apache 2.0. Copyright © Medplum 2021

package/dist/cache.d.ts

@@ -6,6 +6,7 @@ export declare class LRUCache<T> {
     private readonly max;
     private readonly cache;
     constructor(max?: number);
+    clear(): void;
     get(key: string): T | undefined;
     set(key: string, val: T): void;
     private first;

package/dist/cache.js

@@ -10,6 +10,9 @@ class LRUCache {
         this.max = max;
         this.cache = new Map();
     }
+    clear() {
+        this.cache.clear();
+    }
     get(key) {
         const item = this.cache.get(key);
         if (item) {

package/dist/cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AACA;;;GAGG;AACH,MAAa,QAAQ;IAInB,YAAY,GAAG,GAAG,EAAE;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,GAAG,CAAC,GAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,GAAM;QACrB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACvB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACxB;aAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,KAAK;QACX,2DAA2D;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC;CACF;AA/BD,4BA+BC","sourcesContent":["\n/**\n * LRU cache (least recently used)\n * Source: https://stackoverflow.com/a/46432113\n */\nexport class LRUCache<T> {\n  private readonly max: number;\n  private readonly cache: Map<string, T>;\n\n  constructor(max = 10) {\n    this.max = max;\n    this.cache = new Map();\n  }\n\n  get(key: string): T | undefined {\n    const item = this.cache.get(key);\n    if (item) {\n      this.cache.delete(key);\n      this.cache.set(key, item);\n    }\n    return item;\n  }\n\n  set(key: string, val: T) {\n    if (this.cache.has(key)) {\n      this.cache.delete(key);\n    } else if (this.cache.size >= this.max) {\n      this.cache.delete(this.first());\n    }\n    this.cache.set(key, val);\n  }\n\n  private first() {\n    // This works because the Map class maintains ordered keys.\n    return this.cache.keys().next().value;\n  }\n}\n"]}
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,QAAQ;IAInB,YAAY,GAAG,GAAG,EAAE;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,GAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,GAAM;QACrB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACvB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACxB;aAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,KAAK;QACX,2DAA2D;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IACxC,CAAC;CACF;AAnCD,4BAmCC","sourcesContent":["/**\n * LRU cache (least recently used)\n * Source: https://stackoverflow.com/a/46432113\n */\nexport class LRUCache<T> {\n  private readonly max: number;\n  private readonly cache: Map<string, T>;\n\n  constructor(max = 10) {\n    this.max = max;\n    this.cache = new Map();\n  }\n\n  clear() {\n    this.cache.clear();\n  }\n\n  get(key: string): T | undefined {\n    const item = this.cache.get(key);\n    if (item) {\n      this.cache.delete(key);\n      this.cache.set(key, item);\n    }\n    return item;\n  }\n\n  set(key: string, val: T) {\n    if (this.cache.has(key)) {\n      this.cache.delete(key);\n    } else if (this.cache.size >= this.max) {\n      this.cache.delete(this.first());\n    }\n    this.cache.set(key, val);\n  }\n\n  private first() {\n    // This works because the Map class maintains ordered keys.\n    return this.cache.keys().next().value;\n  }\n}\n"]}

package/dist/client.d.ts

@@ -1,14 +1,15 @@
+import { Binary, Bundle, Project, ProjectMembership, Reference, Resource, ValueSet } from '@medplum/fhirtypes';
 import { EventTarget } from './eventtarget';
-import { Binary, Bundle, Project, Reference, Resource, ValueSet } from './fhir';
 import { SearchRequest } from './search';
 import { IndexedStructureDefinition } from './types';
 import { ProfileResource } from './utils';
 export interface MedplumClientOptions {
     /**
      * The client ID.
-     * Required.
+     * 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;
+    clientId?: string;
     /**
      * Base server URL.
      * Optional.  Default value is "https://api.medplum.com/".
@@ -39,12 +40,6 @@ export interface MedplumClientOptions {
      * Consider using this for performance of displaying Patient or Practitioner resources.
      */
     resourceCacheSize?: number;
-    /**
-     * Number of blob URLs to store in the cache.
-     * Optional.  Default value is 100.
-     * Consider using this for performance of displaying Patient or Practitioner resources.
-     */
-    blobCacheSize?: number;
     /**
      * Optional fetch implementation.
      * Optional.  Default is window.fetch.
@@ -61,76 +56,92 @@ export interface MedplumClientOptions {
 export interface FetchLike {
     (url: string, options?: any): Promise<any>;
 }
-interface LoginResponse {
-    project: Project;
-    profile: ProfileResource;
-    accessToken: string;
-    refreshToken: string;
-}
 export interface RegisterRequest {
-    firstName: string;
-    lastName: string;
-    projectName: string;
-    email: string;
-    password: string;
-    remember?: boolean;
+    readonly firstName: string;
+    readonly lastName: string;
+    readonly projectName: string;
+    readonly email: string;
+    readonly password: string;
+    readonly remember?: boolean;
 }
 export interface GoogleCredentialResponse {
     readonly clientId: string;
     readonly credential: string;
 }
+export interface LoginAuthenticationResponse {
+    readonly login: string;
+    readonly code?: string;
+    readonly memberships?: ProjectMembership[];
+}
+export interface LoginProfileResponse {
+    readonly login: string;
+    readonly scope: string;
+}
+export interface LoginScopeResponse {
+    readonly login: string;
+    readonly code: string;
+}
+export interface LoginState {
+    readonly project: Reference<Project>;
+    readonly profile: Reference<ProfileResource>;
+    readonly accessToken: string;
+    readonly refreshToken: string;
+}
+export interface TokenResponse {
+    readonly token_type: string;
+    readonly id_token: string;
+    readonly access_token: string;
+    readonly refresh_token: string;
+    readonly expires_in: number;
+    readonly project: Reference<Project>;
+    readonly profile: Reference<ProfileResource>;
+}
 export declare class MedplumClient extends EventTarget {
     private readonly fetch;
     private readonly storage;
     private readonly schema;
     private readonly resourceCache;
-    private readonly blobUrlCache;
     private readonly baseUrl;
     private readonly clientId;
     private readonly authorizeUrl;
     private readonly tokenUrl;
     private readonly logoutUrl;
     private readonly onUnauthenticated?;
+    private refreshPromise?;
     private activeLogin?;
+    private profile?;
+    private loading;
     constructor(options: MedplumClientOptions);
     /**
      * Clears all auth state including local storage and session storage.
      */
     clear(): void;
-    get(url: string, blob?: boolean): Promise<any>;
+    get(url: string): Promise<any>;
     post(url: string, body: any, contentType?: string): Promise<any>;
     put(url: string, body: any, contentType?: string): Promise<any>;
+    delete(url: string): Promise<any>;
     /**
      * Tries to register a new user.
      * @param request The registration request.
-     * @returns Promise to the user profile resource.
+     * @returns Promise to the authentication response.
      */
-    register(request: RegisterRequest): Promise<ProfileResource>;
+    register(request: RegisterRequest): Promise<void>;
     /**
-     * Tries to sign in with email and password.
-     * @param email The user email address.
-     * @param password The user password.
-     * @param role The login role.
-     * @param scope The OAuth2 login scope.
-     * @param remember Optional flag to "remember" to generate a refresh token and persist in local storage.
-     * @returns Promise to the user profile resource.
+     * Initiates a user login flow.
+     * @param email The email address of the user.
+     * @param password The password of the user.
+     * @param remember Optional flag to remember the user.
+     * @returns Promise to the authentication response.
      */
-    signIn(email: string, password: string, role: string, scope: string, remember?: boolean): Promise<ProfileResource>;
+    startLogin(email: string, password: string, remember?: boolean): Promise<LoginAuthenticationResponse>;
     /**
      * Tries to sign in with Google authentication.
      * The response parameter is the result of a Google authentication.
      * See: https://developers.google.com/identity/gsi/web/guides/handle-credential-responses-js-functions
      * @param googleResponse The Google credential response.
-     * @returns Promise to the user profile resource.
-     */
-    signInWithGoogle(googleResponse: GoogleCredentialResponse): Promise<ProfileResource>;
-    /**
-     * Handles a login response.
-     * This can be used for both "register" and "signIn".
-     * @param response The login response.
-     * @returns The user profile.
+     * @returns Promise to the authentication response.
      */
-    private handleLoginResponse;
+    startGoogleLogin(googleResponse: GoogleCredentialResponse): Promise<LoginAuthenticationResponse>;
     /**
      * Signs out locally.
      * Does not invalidate tokens with the server.
@@ -164,28 +175,26 @@ export declare class MedplumClient extends EventTarget {
     getTypeDefinition(resourceType: string): Promise<IndexedStructureDefinition>;
     readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
     readPatientEverything(id: string): Promise<Bundle>;
-    readBlob(url: string): Promise<Blob>;
-    readBlobAsObjectUrl(url: string): Promise<string>;
-    readCachedBlobAsObjectUrl(url: string): Promise<string>;
-    readBinary(id: string): Promise<Blob>;
     create<T extends Resource>(resource: T): Promise<T>;
     createBinary(data: any, contentType: string): Promise<Binary>;
     update<T extends Resource>(resource: T): Promise<T>;
     patch(resourceType: string, id: string, operations: any): Promise<any>;
+    deleteResource(resourceType: string, id: string): Promise<any>;
     graphql(gql: any): Promise<any>;
     subscribe(criteria: string, handler: (e: Resource) => void): Promise<EventSource>;
-    getActiveLogin(): LoginResponse | undefined;
-    setActiveLogin(login: LoginResponse): void;
-    getLogins(): LoginResponse[];
-    addLogin(newLogin: LoginResponse): void;
+    getActiveLogin(): LoginState | undefined;
+    setActiveLogin(login: LoginState): Promise<void>;
+    getLogins(): LoginState[];
+    private addLogin;
+    private refreshProfile;
     getProfile(): ProfileResource | undefined;
+    isLoading(): boolean;
     /**
      * Makes an HTTP request.
      * @param {string} method
      * @param {string} url
      * @param {string=} contentType
      * @param {Object=} body
-     * @param {boolean=} blob
      */
     private request;
     /**
@@ -196,9 +205,13 @@ export declare class MedplumClient extends EventTarget {
      * @param url The URL of the original request.
      * @param contentType The content type of the original request.
      * @param body The body of the original request.
-     * @param blob Optional blob flag of the original request.
      */
     private handleUnauthenticated;
+    /**
+     * Starts a new PKCE flow.
+     * These PKCE values are stateful, and must survive redirects and page refreshes.
+     */
+    private startPkce;
     /**
      * Redirects the user to the login screen for authorization.
      * Clears all auth state including local storage and session storage.
@@ -210,7 +223,7 @@ export declare class MedplumClient extends EventTarget {
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenRequest
      * @param code The authorization code received by URL parameter.
      */
-    private processCode;
+    processCode(code: string): Promise<ProfileResource>;
     /**
      * Tries to refresh the auth tokens.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens
@@ -230,4 +243,3 @@ export declare class MedplumClient extends EventTarget {
      */
     private verifyTokens;
 }
-export {};