@medplum/core 0.9.5 → 0.9.6

package/dist/types/client.d.ts

@@ -1,5 +1,6 @@
-import { Binary, Bundle, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
+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 { EventTarget } from './eventtarget';
 import { Hl7Message } from './hl7';
 import { ReadablePromise } from './readablepromise';
@@ -59,6 +60,12 @@ export interface MedplumClientOptions {
 export interface FetchLike {
     (url: string, options?: any): Promise<any>;
 }
+export interface LoginRequest {
+    readonly email: string;
+    readonly password: string;
+    readonly remember?: boolean;
+    readonly projectId?: string;
+}
 export interface RegisterRequest {
     readonly firstName: string;
     readonly lastName: string;
@@ -232,12 +239,10 @@ export declare class MedplumClient extends EventTarget {
     register(request: RegisterRequest): Promise<void>;
     /**
      * 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.
+     * @param loginRequest Login request including email and password.
      * @returns Promise to the authentication response.
      */
-    startLogin(email: string, password: string, remember?: boolean): Promise<LoginAuthenticationResponse>;
+    startLogin(loginRequest: LoginRequest): Promise<LoginAuthenticationResponse>;
     /**
      * Tries to sign in with Google authentication.
      * The response parameter is the result of a Google authentication.
@@ -688,6 +693,44 @@ export declare class MedplumClient extends EventTarget {
      * @returns The result of the delete operation.
      */
     deleteResource(resourceType: string, id: string): Promise<any>;
+    /**
+     * Sends an email using the Medplum Email API.
+     *
+     * Builds the email using nodemailer MailComposer.
+     *
+     * Examples:
+     *
+     * Send a simple text email:
+     *
+     * ```typescript
+     * await medplum.sendEmail({
+     *   to: 'alice@example.com',
+     *   cc: 'bob@example.com',
+     *   subject: 'Hello',
+     *   text: 'Hello Alice',
+     * });
+     * ```
+     *
+     * Send an email with a `Binary` attachment:
+     *
+     * ```typescript
+     * await medplum.sendEmail({
+     *   to: 'alice@example.com',
+     *   subject: 'Email with attachment',
+     *   text: 'See the attached report',
+     *   attachments: [{
+     *     filename: 'report.pdf',
+     *     path: "Binary/" + binary.id
+     *   }]
+     * });
+     * ```
+     *
+     * See options here: https://nodemailer.com/extras/mailcomposer/
+     *
+     * @param options The MailComposer options.
+     * @returns Promise to the operation outcome.
+     */
+    sendEmail(email: Mail.Options): Promise<OperationOutcome>;
     graphql(query: string, options?: RequestInit): Promise<any>;
     getActiveLogin(): LoginState | undefined;
     setActiveLogin(login: LoginState): Promise<void>;

package/package.json

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