npm - @medplum/core - Versions diffs - 2.0.21 → 2.0.22 - Mend

@medplum/core 2.0.21 → 2.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/dist/cjs/index.cjs +380 -288
package/dist/cjs/index.cjs.map +1 -1
package/dist/cjs/index.min.cjs +1 -1
package/dist/esm/client.mjs +132 -102
package/dist/esm/client.mjs.map +1 -1
package/dist/esm/crypto.mjs +3 -1
package/dist/esm/crypto.mjs.map +1 -1
package/dist/esm/fhirpath/functions.mjs +179 -129
package/dist/esm/fhirpath/functions.mjs.map +1 -1
package/dist/esm/format.mjs +6 -4
package/dist/esm/format.mjs.map +1 -1
package/dist/esm/hl7.mjs +1 -1
package/dist/esm/hl7.mjs.map +1 -1
package/dist/esm/index.min.mjs +1 -1
package/dist/esm/index.mjs +1 -0
package/dist/esm/index.mjs.map +1 -1
package/dist/esm/jwt.mjs +4 -2
package/dist/esm/jwt.mjs.map +1 -1
package/dist/esm/schema.mjs +4 -10
package/dist/esm/schema.mjs.map +1 -1
package/dist/esm/search/details.mjs +0 -1
package/dist/esm/search/details.mjs.map +1 -1
package/dist/esm/search/match.mjs +1 -0
package/dist/esm/search/match.mjs.map +1 -1
package/dist/esm/search/search.mjs +1 -1
package/dist/esm/search/search.mjs.map +1 -1
package/dist/esm/storage.mjs +8 -0
package/dist/esm/storage.mjs.map +1 -1
package/dist/esm/types.mjs +1 -0
package/dist/esm/types.mjs.map +1 -1
package/dist/esm/utils.mjs +8 -7
package/dist/esm/utils.mjs.map +1 -1
package/dist/types/client.d.ts +74 -64
package/dist/types/crypto.d.ts +3 -1
package/dist/types/hl7.d.ts +1 -1
package/dist/types/index.d.ts +1 -0
package/dist/types/jwt.d.ts +2 -1
package/dist/types/schema.d.ts +4 -10
package/dist/types/search/details.d.ts +0 -1
package/dist/types/search/search.d.ts +1 -1
package/dist/types/storage.d.ts +8 -0
package/dist/types/typeschema/types.d.ts +0 -1
package/dist/types/utils.d.ts +4 -4
package/package.json +1 -1

package/dist/types/client.d.ts CHANGED Viewed

@@ -392,7 +392,6 @@ export declare enum OAuthTokenType {
  *  <head>
  *    <meta name="algolia:pageRank" content="100" />
  *  </head>
  */
 export declare class MedplumClient extends EventTarget {
     private readonly fetch;
@@ -461,7 +460,6 @@ export declare class MedplumClient extends EventTarget {
      * This is a lower level method for custom requests.
      * For common operations, we recommend using higher level methods
      * such as `readResource()`, `search()`, etc.
-     *
      * @category HTTP
      * @param url The target URL.
      * @param options Optional fetch options.
@@ -474,7 +472,6 @@ export declare class MedplumClient extends EventTarget {
      * This is a lower level method for custom requests.
      * For common operations, we recommend using higher level methods
      * such as `createResource()`.
-     *
      * @category HTTP
      * @param url The target URL.
      * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
@@ -489,7 +486,6 @@ export declare class MedplumClient extends EventTarget {
      * This is a lower level method for custom requests.
      * For common operations, we recommend using higher level methods
      * such as `updateResource()`.
-     *
      * @category HTTP
      * @param url The target URL.
      * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
@@ -504,7 +500,6 @@ export declare class MedplumClient extends EventTarget {
      * This is a lower level method for custom requests.
      * For common operations, we recommend using higher level methods
      * such as `patchResource()`.
-     *
      * @category HTTP
      * @param url The target URL.
      * @param operations Array of JSONPatch operations.
@@ -519,7 +514,6 @@ export declare class MedplumClient extends EventTarget {
      * This is a lower level method for custom requests.
      * For common operations, we recommend using higher level methods
      * such as `deleteResource()`.
-     *
      * @category HTTP
      * @param url The target URL.
      * @param options Optional fetch options.
@@ -532,46 +526,48 @@ export declare class MedplumClient extends EventTarget {
      * This method is part of the two different user registration flows:
      * 1) New Practitioner and new Project
      * 2) New Patient registration
-     *
      * @category Authentication
      * @param newUserRequest Register request including email and password.
+     * @param options Optional fetch options.
      * @returns Promise to the authentication response.
      */
-    startNewUser(newUserRequest: NewUserRequest): Promise<LoginAuthenticationResponse>;
+    startNewUser(newUserRequest: NewUserRequest, options?: RequestInit): Promise<LoginAuthenticationResponse>;
     /**
      * Initiates a new project flow.
      *
      * This requires a partial login from `startNewUser` or `startNewGoogleUser`.
-     *
      * @param newProjectRequest Register request including email and password.
+     * @param options Optional fetch options.
      * @returns Promise to the authentication response.
      */
-    startNewProject(newProjectRequest: NewProjectRequest): Promise<LoginAuthenticationResponse>;
+    startNewProject(newProjectRequest: NewProjectRequest, options?: RequestInit): Promise<LoginAuthenticationResponse>;
     /**
      * Initiates a new patient flow.
      *
      * This requires a partial login from `startNewUser` or `startNewGoogleUser`.
-     *
      * @param newPatientRequest Register request including email and password.
+     * @param options Optional fetch options.
      * @returns Promise to the authentication response.
      */
-    startNewPatient(newPatientRequest: NewPatientRequest): Promise<LoginAuthenticationResponse>;
+    startNewPatient(newPatientRequest: NewPatientRequest, options?: RequestInit): Promise<LoginAuthenticationResponse>;
     /**
      * Initiates a user login flow.
      * @category Authentication
      * @param loginRequest Login request including email and password.
+     * @param options Optional fetch options.
      * @returns Promise to the authentication response.
      */
-    startLogin(loginRequest: EmailPasswordLoginRequest): Promise<LoginAuthenticationResponse>;
+    startLogin(loginRequest: EmailPasswordLoginRequest, options?: RequestInit): 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
      * @category Authentication
      * @param loginRequest Login request including Google credential response.
+     * @param options Optional fetch options.
      * @returns Promise to the authentication response.
      */
-    startGoogleLogin(loginRequest: GoogleLoginRequest): Promise<LoginAuthenticationResponse>;
+    startGoogleLogin(loginRequest: GoogleLoginRequest, options?: RequestInit): Promise<LoginAuthenticationResponse>;
     /**
      * Returns the PKCE code challenge and method.
      * If the login request already includes a code challenge, it is returned.
@@ -593,6 +589,7 @@ export declare class MedplumClient extends EventTarget {
      * This may result in navigating away to the sign in page.
      * @category Authentication
      * @param loginParams Optional login parameters.
+     * @returns The user profile resource if available.
      */
     signInWithRedirect(loginParams?: Partial<BaseLoginRequest>): Promise<ProfileResource | void>;
     /**
@@ -614,6 +611,7 @@ export declare class MedplumClient extends EventTarget {
      * Exchange an external access token for a Medplum access token.
      * @param token The access token that was generated by the external identity provider.
      * @param clientId The ID of the `ClientApplication` in your Medplum project that will be making the exchange request.
+     * @returns The user profile resource.
      * @category Authentication
      */
     exchangeExternalAccessToken(token: string, clientId?: string): Promise<ProfileResource>;
@@ -685,7 +683,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
      * @category Search
      * @param resourceType The FHIR resource type.
      * @param query Optional FHIR search query or structured query object. Can be any valid input to the URLSearchParams() constructor.
@@ -708,7 +705,6 @@ export declare class MedplumClient extends EventTarget {
      * The return value is the resource, if available; otherwise, undefined.
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
      * @category Search
      * @param resourceType The FHIR resource type.
      * @param query Optional FHIR search query or structured query object. Can be any valid input to the URLSearchParams() constructor.
@@ -731,7 +727,6 @@ export declare class MedplumClient extends EventTarget {
      * The return value is an array of resources.
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
      * @category Search
      * @param resourceType The FHIR resource type.
      * @param query Optional FHIR search query or structured query object. Can be any valid input to the URLSearchParams() constructor.
@@ -753,18 +748,16 @@ export declare class MedplumClient extends EventTarget {
      *  }
      * }
      * ```
-     *
      * @category Search
      * @param resourceType The FHIR resource type.
      * @param query Optional FHIR search query or structured query object. Can be any valid input to the URLSearchParams() constructor.
      * @param options Optional fetch options.
-     * @returns An async generator, where each result is an array of resources for each page.
+     * @yields An async generator, where each result is an array of resources for each page.
      */
     searchResourcePages<K extends ResourceType>(resourceType: K, query?: QueryTypes, options?: RequestInit): AsyncGenerator<ExtractResource<K>[]>;
     /**
      * Searches a ValueSet resource using the "expand" operation.
      * See: https://www.hl7.org/fhir/operation-valueset-expand.html
-     *
      * @category Search
      * @param system The ValueSet system url.
      * @param filter The search string.
@@ -783,8 +776,7 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Returns a cached resource if it is available.
      * @category Caching
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
+     * @param reference The FHIR reference.
      * @returns The resource if it is available in the cache; undefined otherwise.
      */
     getCachedReference<T extends Resource>(reference: Reference<T>): T | undefined;
@@ -799,7 +791,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
@@ -821,7 +812,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
      * @category Read
      * @param reference The FHIR reference object.
      * @param options Optional fetch options.
@@ -858,7 +848,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "history" operation for full details: https://www.hl7.org/fhir/http.html#history
-     *
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
@@ -877,7 +866,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "vread" operation for full details: https://www.hl7.org/fhir/http.html#vread
-     *
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
@@ -897,7 +885,6 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "patient-everything" operation for full details: https://hl7.org/fhir/operation-patient-everything.html
-     *
      * @category Read
      * @param id The Patient Id
      * @param options Optional fetch options.
@@ -923,12 +910,12 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
-     *
      * @category Create
      * @param resource The FHIR resource to create.
+     * @param options Optional fetch options.
      * @returns The result of the create operation.
      */
-    createResource<T extends Resource>(resource: T): Promise<T>;
+    createResource<T extends Resource>(resource: T, options?: RequestInit): Promise<T>;
     /**
      * Conditionally create a new FHIR resource only if some equivalent resource does not already exist on the server.
      *
@@ -963,13 +950,13 @@ export declare class MedplumClient extends EventTarget {
      * 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
-     *
      * @category Create
      * @param resource The FHIR resource to create.
      * @param query The search query for an equivalent resource (should not include resource type or "?").
+     * @param options Optional fetch options.
      * @returns The result of the create operation.
      */
-    createResourceIfNoneExist<T extends Resource>(resource: T, query: string): Promise<T>;
+    createResourceIfNoneExist<T extends Resource>(resource: T, query: string, options?: RequestInit): Promise<T>;
     /**
      * Creates a FHIR `Binary` resource with the provided data content.
      *
@@ -987,11 +974,11 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
-     *
      * @category Create
      * @param data The binary data to upload.
      * @param filename Optional filename for the binary.
      * @param contentType Content type for the binary.
+     * @param onProgress Optional callback for progress events.
      * @returns The result of the create operation.
      */
     createBinary(data: string | File | Blob | Uint8Array, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void): Promise<Binary>;
@@ -1013,9 +1000,11 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
-     *
      * @category Media
      * @param docDefinition The PDF document definition.
+     * @param filename Optional filename for the PDF binary resource.
+     * @param tableLayouts Optional pdfmake custom table layout.
+     * @param fonts Optional pdfmake custom font dictionary.
      * @returns The result of the create operation.
      */
     createPdf(docDefinition: TDocumentDefinitions, filename?: string, tableLayouts?: {
@@ -1025,13 +1014,13 @@ export declare class MedplumClient extends EventTarget {
      * 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`.
-     *
      * @category Create
      * @param resource The FHIR resource to comment on.
      * @param text The text of the comment.
+     * @param options Optional fetch options.
      * @returns The result of the create operation.
      */
-    createComment(resource: Resource, text: string): Promise<Communication>;
+    createComment(resource: Resource, text: string, options?: RequestInit): Promise<Communication>;
     /**
      * Updates a FHIR resource.
      *
@@ -1052,12 +1041,12 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#update
-     *
      * @category Write
      * @param resource The FHIR resource to update.
+     * @param options Optional fetch options.
      * @returns The result of the update operation.
      */
-    updateResource<T extends Resource>(resource: T): Promise<T>;
+    updateResource<T extends Resource>(resource: T, options?: RequestInit): Promise<T>;
     /**
      * Updates a FHIR resource using JSONPatch operations.
      *
@@ -1075,14 +1064,14 @@ export declare class MedplumClient extends EventTarget {
      * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#patch
      *
      * See the JSONPatch specification for full details: https://tools.ietf.org/html/rfc6902
-     *
      * @category Write
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @param operations The JSONPatch operations.
+     * @param options Optional fetch options.
      * @returns The result of the patch operations.
      */
-    patchResource<K extends ResourceType>(resourceType: K, id: string, operations: PatchOperation[]): Promise<ExtractResource<K>>;
+    patchResource<K extends ResourceType>(resourceType: K, id: string, operations: PatchOperation[], options?: RequestInit): Promise<ExtractResource<K>>;
     /**
      * Deletes a FHIR resource by resource type and ID.
      *
@@ -1093,13 +1082,13 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "delete" operation for full details: https://www.hl7.org/fhir/http.html#delete
-     *
      * @category Delete
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
+     * @param options Optional fetch options.
      * @returns The result of the delete operation.
      */
-    deleteResource(resourceType: ResourceType, id: string): Promise<any>;
+    deleteResource(resourceType: ResourceType, id: string, options?: RequestInit): Promise<any>;
     /**
      * Executes the validate operation with the provided resource.
      *
@@ -1113,11 +1102,11 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See the FHIR "$validate" operation for full details: https://www.hl7.org/fhir/resource-operation-validate.html
-     *
      * @param resource The FHIR resource.
+     * @param options Optional fetch options.
      * @returns The validate operation outcome.
      */
-    validateResource<T extends Resource>(resource: T): Promise<OperationOutcome>;
+    validateResource<T extends Resource>(resource: T, options?: RequestInit): Promise<OperationOutcome>;
     /**
      * Executes a bot by ID.
      * @param id The Bot ID.
@@ -1219,10 +1208,11 @@ export declare class MedplumClient extends EventTarget {
      *
      * See options here: https://nodemailer.com/extras/mailcomposer/
      * @category Media
-     * @param options The MailComposer options.
+     * @param email The MailComposer options.
+     * @param options Optional fetch options.
      * @returns Promise to the operation outcome.
      */
-    sendEmail(email: MailOptions): Promise<OperationOutcome>;
+    sendEmail(email: MailOptions, options?: RequestInit): Promise<OperationOutcome>;
     /**
      * Executes a GraphQL query.
      *
@@ -1263,7 +1253,6 @@ export declare class MedplumClient extends EventTarget {
      * See the GraphQL documentation for more details: https://graphql.org/learn/
      *
      * See the FHIR GraphQL documentation for FHIR specific details: https://www.hl7.org/fhir/graphql.html
-     *
      * @category Read
      * @param query The GraphQL query.
      * @param operationName Optional GraphQL operation name.
@@ -1276,75 +1265,91 @@ export declare class MedplumClient extends EventTarget {
      *
      * Executes the $graph operation on this resource to fetch a Bundle of resources linked to the target resource
      * according to a graph definition
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @param graphName `name` parameter of the GraphDefinition
+     * @param options Optional fetch options.
      * @returns A Bundle
      */
-    readResourceGraph<K extends ResourceType>(resourceType: K, id: string, graphName: string): ReadablePromise<Bundle<Resource>>;
+    readResourceGraph<K extends ResourceType>(resourceType: K, id: string, graphName: string, options?: RequestInit): ReadablePromise<Bundle<Resource>>;
     /**
      * @category Authentication
      * @returns The Login State
      */
     getActiveLogin(): LoginState | undefined;
     /**
+     * Sets the active login.
+     * @param login The new active login state.
      * @category Authentication
      */
     setActiveLogin(login: LoginState): Promise<void>;
     /**
      * Returns the current access token.
+     * @returns The current access token.
      * @category Authentication
      */
     getAccessToken(): string | undefined;
     /**
      * Sets the current access token.
+     * @param accessToken The new access token.
      * @category Authentication
      */
     setAccessToken(accessToken: string): void;
     /**
+     * Returns the list of available logins.
+     * @returns The list of available logins.
      * @category Authentication
      */
     getLogins(): LoginState[];
     private addLogin;
     private refreshProfile;
     /**
+     * Returns true if the client is waiting for authentication.
+     * @returns True if the client is waiting for authentication.
      * @category Authentication
      */
     isLoading(): boolean;
     /**
+     * Returns the current user profile resource if available.
+     * This method does not wait for loading promises.
+     * @returns The current user profile resource if available.
      * @category User Profile
      */
     getProfile(): ProfileResource | undefined;
     /**
+     * Returns the current user profile resource if available.
+     * This method waits for loading promises.
+     * @returns The current user profile resource if available.
      * @category User Profile
      */
     getProfileAsync(): Promise<ProfileResource | undefined>;
     /**
+     * Returns the current user configuration if available.
+     * @returns The current user configuration if available.
      * @category User Profile
      */
     getUserConfiguration(): UserConfiguration | undefined;
     /**
      * Downloads the URL as a blob.
-     *
      * @category Read
      * @param url The URL to request.
+     * @param options Optional fetch request init options.
      * @returns Promise to the response body as a blob.
      */
     download(url: URL | string, options?: RequestInit): Promise<Blob>;
     /**
      * Upload media to the server and create a Media instance for the uploaded content.
      * @param contents The contents of the media file, as a string, Uint8Array, File, or Blob.
-     * @param contentType The media type of the content
-     * @param filename The name of the file to be uploaded, or undefined if not applicable
-     * @param additionalFields  Additional fields for Media
+     * @param contentType The media type of the content.
+     * @param filename The name of the file to be uploaded, or undefined if not applicable.
+     * @param additionalFields Additional fields for Media.
+     * @param options Optional fetch options.
      * @returns Promise that resolves to the created Media
      */
-    uploadMedia(contents: string | Uint8Array | File | Blob, contentType: string, filename: string | undefined, additionalFields?: Partial<Media>): Promise<Media>;
+    uploadMedia(contents: string | Uint8Array | File | Blob, contentType: string, filename: string | undefined, additionalFields?: Partial<Media>, options?: RequestInit): Promise<Media>;
     /**
      * Performs Bulk Data Export operation request flow. See The FHIR "Bulk Data Export" for full details: https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-export
-     *
      * @param exportLevel Optional export level. Defaults to system level export. 'Group/:id' - Group of Patients, 'Patient' - All Patients.
      * @param resourceTypes A string of comma-delimited FHIR resource types.
      * @param since Resources will be included in the response if their state has changed after the supplied time (e.g. if Resource.meta.lastUpdated is later than the supplied _since time).
@@ -1379,10 +1384,10 @@ export declare class MedplumClient extends EventTarget {
     private deleteCacheEntry;
     /**
      * Makes an HTTP request.
-     * @param {string} method
-     * @param {string} url
-     * @param {string=} contentType
-     * @param {Object=} body
+     * @param method The HTTP method (GET, POST, etc).
+     * @param url The target URL.
+     * @param options Optional fetch request init options.
+     * @returns The JSON content body if available.
      */
     private request;
     private parseResponse;
@@ -1415,14 +1420,15 @@ export declare class MedplumClient extends EventTarget {
      * Otherwise, calls unauthenticated callbacks and rejects.
      * @param method The HTTP method of the original request.
      * @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 options Optional fetch request init options.
+     * @returns The result of the retry.
      */
     private handleUnauthenticated;
     /**
      * Starts a new PKCE flow.
      * These PKCE values are stateful, and must survive redirects and page refreshes.
      * @category Authentication
+     * @returns The PKCE code challenge details.
      */
     startPkce(): Promise<{
         codeChallengeMethod: string;
@@ -1431,7 +1437,8 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Redirects the user to the login screen for authorization.
      * Clears all auth state including local storage and session storage.
-     * See: https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint
+     * @param loginParams The authorization login parameters.
+     * @see https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint
      */
     private requestAuthorization;
     /**
@@ -1439,12 +1446,14 @@ 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.
      * @param loginParams Optional login parameters.
+     * @returns The user profile resource.
      * @category Authentication
      */
     processCode(code: string, loginParams?: Partial<BaseLoginRequest>): Promise<ProfileResource>;
     /**
      * Tries to refresh the auth tokens.
-     * See: https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens
+     * @returns The refresh promise if available; otherwise undefined.
+     * @see https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens
      */
     private refresh;
     /**
@@ -1472,7 +1481,6 @@ export declare class MedplumClient extends EventTarget {
      * // Example Search
      * await medplum.searchResources('Patient')
      * ```
-     *
      * @category Authentication
      * @param clientId The client ID.
      * @param clientSecret The client secret.
@@ -1489,13 +1497,15 @@ export declare class MedplumClient extends EventTarget {
      * Makes a POST request to the tokens endpoint.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint
      * @param formBody Token parameters in URL encoded format.
+     * @returns The user profile resource.
      */
     private fetchTokens;
     /**
      * Verifies the tokens received from the auth server.
      * Validates the JWT against the JWKS.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint
-     * @param tokens
+     * @param tokens The token response.
+     * @returns Promise to complete.
      */
     private verifyTokens;
     /**

package/dist/types/crypto.d.ts CHANGED Viewed

@@ -1,9 +1,11 @@
 /**
  * Returns a cryptographically secure random string.
+ * @returns A cryptographically secure random string.
  */
 export declare function getRandomString(): string;
 /**
  * Encrypts a string with SHA256 encryption.
- * @param str
+ * @param str The unencrypted input string.
+ * @returns The encrypted value in an ArrayBuffer.
  */
 export declare function encryptSHA256(str: string): Promise<ArrayBuffer>;

package/dist/types/hl7.d.ts CHANGED Viewed

@@ -142,7 +142,7 @@ interface Hl7DateParseOptions {
  * Returns a formatted string representing the date in ISO-8601 format.
  * @param hl7Date Date string.
  * @param options Optional configuration Object
- * @returns
+ * @returns The date in ISO-8601 format.
  */
 export declare function parseHl7Date(hl7Date: string | undefined, options?: Hl7DateParseOptions): string | undefined;
 export {};

package/dist/types/index.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+export * from './base64';
 export * from './bundle';
 export * from './cache';
 export * from './client';

package/dist/types/jwt.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 /**
  * Parses the JWT payload.
- * @param token JWT token
+ * @param token JWT token.
+ * @returns Collection of key value claims in the JWT payload.
  */
 export declare function parseJWTPayload(token: string): Record<string, number | string>;

package/dist/types/schema.d.ts CHANGED Viewed

@@ -27,7 +27,6 @@ import { OperationOutcomeIssue, Resource } from '@medplum/fhirtypes';
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
  * @param resourceType The candidate resource type string.
  * @returns True if the resource type is a valid FHIR resource type.
  */
@@ -62,9 +61,7 @@ export declare function isResourceType(resourceType: string): boolean;
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
  * @param resourceType The candidate resource type string.
- * @returns True if the resource type is a valid FHIR resource type.
  */
 export declare function validateResourceType(resourceType: string): void;
 /**
@@ -97,9 +94,7 @@ export declare function validateResourceType(resourceType: string): void;
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
- * @param resourceType The candidate resource type string.
- * @returns True if the resource type is a valid FHIR resource type.
+ * @param resource The candidate resource.
  */
 export declare function validateResource<T extends Resource>(resource: T): void;
 export declare class FhirSchemaValidator<T extends Resource> {
@@ -131,10 +126,10 @@ export declare class FhirSchemaValidator<T extends Resource> {
      *   2) a JSON property with _ prepended to the name of the element, which, if present, contains the value's id and/or extensions
      *
      * See: https://hl7.org/fhir/json.html#primitive
-     *
      * @param path The path to the property
-     * @param key
-     * @param typedValue
+     * @param key The key in the current typed value.
+     * @param typedValue The current typed value.
+     * @returns True if the primitive element is valid.
      */
     private checkPrimitiveElement;
     private createIssue;
@@ -143,7 +138,6 @@ export declare class FhirSchemaValidator<T extends Resource> {
  * Recursively checks for null values in an object.
  *
  * Note that "null" is a special value in JSON that is not allowed in FHIR.
- *
  * @param value Input value of any type.
  * @param path Path string to the value for OperationOutcome.
  * @param issues Output list of issues.

package/dist/types/search/details.d.ts CHANGED Viewed

@@ -26,7 +26,6 @@ export interface SearchParameterDetails {
  *   1) The "date" type includes "date", "datetime", and "period".
  *   2) The "token" type includes enums and booleans.
  *   3) Arrays/multiple values are not reflected at all.
- *
  * @param resourceType The root resource type.
  * @param searchParam The search parameter.
  * @returns The search parameter type details.

package/dist/types/search/search.d.ts CHANGED Viewed

@@ -79,7 +79,7 @@ export declare function parseSearchDefinition<T extends Resource = Resource>(url
 /**
  * Formats a search definition object into a query string.
  * Note: The return value does not include the resource type.
- * @param {!SearchRequest} definition The search definition.
+ * @param definition The search definition.
  * @returns Formatted URL.
  */
 export declare function formatSearchQuery(definition: SearchRequest): string;