@medplum/core 0.9.21 → 0.9.22

package/dist/cjs/index.js

@@ -6190,6 +6190,7 @@
          * 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.
+         * @category HTTP
          * @returns The current base URL for all API requests.
          */
         getBaseUrl() {
@@ -6197,6 +6198,7 @@
         }
         /**
          * Clears all auth state including local storage and session storage.
+         * @category Authentication
          */
         clear() {
             __classPrivateFieldGet(this, _MedplumClient_storage, "f").clear();
@@ -6209,6 +6211,7 @@
         }
         /**
          * Invalidates any cached values or cached requests for the given URL.
+         * @category Caching
          * @param url The URL to invalidate.
          */
         invalidateUrl(url) {
@@ -6217,6 +6220,7 @@
         }
         /**
          * Invalidates all cached search results or cached requests for the given resourceType.
+         * @category Caching
          * @param resourceType The resource type to invalidate.
          */
         invalidateSearches(resourceType) {
@@ -6234,6 +6238,7 @@
          * 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.
          * @returns Promise to the response content.
@@ -6255,6 +6260,7 @@
          * 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.
          * @param contentType The content type to be included in the "Content-Type" header.
@@ -6279,6 +6285,7 @@
          * 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.
          * @param contentType The content type to be included in the "Content-Type" header.
@@ -6303,6 +6310,7 @@
          * 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.
          * @param options Optional fetch options.
@@ -6318,10 +6326,12 @@
         /**
          * Makes an HTTP DELETE request to the specified URL.
          *
+         *
          * 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.
          * @returns Promise to the response content.
@@ -6333,6 +6343,7 @@
         }
         /**
          * Tries to register a new user.
+         * @category Authentication
          * @param request The registration request.
          * @returns Promise to the authentication response.
          */
@@ -6344,6 +6355,7 @@
         }
         /**
          * Initiates a user login flow.
+         * @category Authentication
          * @param loginRequest Login request including email and password.
          * @returns Promise to the authentication response.
          */
@@ -6358,6 +6370,7 @@
          * 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.
          * @returns Promise to the authentication response.
          */
@@ -6371,6 +6384,7 @@
         /**
          * Signs out locally.
          * Does not invalidate tokens with the server.
+         * @category Authentication
          */
         signOut() {
             this.clear();
@@ -6380,6 +6394,7 @@
          * Tries to sign in the user.
          * Returns true if the user is signed in.
          * This may result in navigating away to the sign in page.
+         * @category Authentication
          */
         signInWithRedirect() {
             const urlParams = new URLSearchParams(window.location.search);
@@ -6395,6 +6410,7 @@
         /**
          * Tries to sign out the user.
          * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
+         * @category Authentication
          */
         signOutWithRedirect() {
             window.location.assign(__classPrivateFieldGet(this, _MedplumClient_logoutUrl, "f"));
@@ -6402,6 +6418,7 @@
         /**
          * Builds a FHIR URL from a collection of URL path components.
          * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
+         * @category HTTP
          * @param path The path component of the URL.
          * @returns The well-formed FHIR URL.
          */
@@ -6410,6 +6427,8 @@
         }
         /**
          * Builds a FHIR search URL from a search query or structured query object.
+         * @category HTTP
+         * @category Search
          * @param query The FHIR search query or structured query object.
          * @returns The well-formed FHIR URL.
          */
@@ -6457,6 +6476,7 @@
          *
          * See FHIR search for full details: https://www.hl7.org/fhir/search.html
          *
+         * @category Search
          * @param query The search query as either a string or a structured search object.
          * @returns Promise to the search result bundle.
          */
@@ -6479,6 +6499,7 @@
          *
          * See FHIR search for full details: https://www.hl7.org/fhir/search.html
          *
+         * @category Search
          * @param query The search query as either a string or a structured search object.
          * @returns Promise to the search result bundle.
          */
@@ -6511,6 +6532,7 @@
          *
          * See FHIR search for full details: https://www.hl7.org/fhir/search.html
          *
+         * @category Search
          * @param query The search query as either a string or a structured search object.
          * @returns Promise to the search result bundle.
          */
@@ -6528,6 +6550,8 @@
         /**
          * 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.
          * @returns Promise to expanded ValueSet.
@@ -6540,6 +6564,7 @@
         }
         /**
          * Returns a cached resource if it is available.
+         * @category Caching
          * @param resourceType The FHIR resource type.
          * @param id The FHIR resource ID.
          * @returns The resource if it is available in the cache; undefined otherwise.
@@ -6551,6 +6576,7 @@
         }
         /**
          * Returns a cached resource if it is available.
+         * @category Caching
          * @param resourceType The FHIR resource type.
          * @param id The FHIR resource ID.
          * @returns The resource if it is available in the cache; undefined otherwise.
@@ -6578,6 +6604,7 @@
          *
          * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
          *
+         * @category Caching
          * @param resourceType The FHIR resource type.
          * @param id The resource ID.
          * @returns The resource if available; undefined otherwise.
@@ -6600,6 +6627,7 @@
          *
          * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
          *
+         * @category Read
          * @param reference The FHIR reference object.
          * @returns The resource if available; undefined otherwise.
          */
@@ -6618,6 +6646,7 @@
          * Returns a cached schema for a resource type.
          * If the schema is not cached, returns undefined.
          * It is assumed that a client will call requestSchema before using this method.
+         * @category Schema
          * @param resourceType The FHIR resource type.
          * @returns The schema if immediately available, undefined otherwise.
          * @deprecated Use globalSchema instead.
@@ -6628,6 +6657,7 @@
         /**
          * Requests the schema for a resource type.
          * If the schema is already cached, the promise is resolved immediately.
+         * @category Schema
          * @param resourceType The FHIR resource type.
          * @returns Promise to a schema with the requested resource type.
          */
@@ -6689,6 +6719,7 @@
          *
          * 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.
          * @returns Promise to the resource history.
@@ -6708,6 +6739,7 @@
          *
          * 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.
          * @returns The resource if available; undefined otherwise.
@@ -6715,6 +6747,12 @@
         readVersion(resourceType, id, vid) {
             return this.get(this.fhirUrl(resourceType, id, '_history', vid));
         }
+        /**
+         *
+         * @category Read
+         * @param id The Patient Id
+         * @returns A Bundle of all Resources related to the Patient
+         */
         readPatientEverything(id) {
             return this.get(this.fhirUrl('Patient', id, '$everything'));
         }
@@ -6738,6 +6776,7 @@
          *
          * 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.
          * @returns The result of the create operation.
          */
@@ -6782,6 +6821,7 @@
          *
          * 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.
          * @returns The result of the create operation.
@@ -6810,6 +6850,7 @@
          *
          * 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.
@@ -6840,6 +6881,7 @@
          *
          * 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.
          * @returns The result of the create operation.
          */
@@ -6857,6 +6899,7 @@
          *
          * 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.
          * @returns The result of the create operation.
@@ -6907,6 +6950,7 @@
          *
          * 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.
          * @returns The result of the update operation.
          */
@@ -6938,6 +6982,7 @@
          *
          * 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.
@@ -6958,6 +7003,7 @@
          *
          * 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.
          * @returns The result of the delete operation.
@@ -7009,7 +7055,7 @@
          * ```
          *
          * See The FHIR "batch/transaction" section for full details: https://hl7.org/fhir/http.html#transaction
-         *
+         * @category Batch
          * @param bundle The FHIR batch/transaction bundle.
          * @returns The FHIR batch/transaction response bundle.
          */
@@ -7049,7 +7095,7 @@
          * ```
          *
          * See options here: https://nodemailer.com/extras/mailcomposer/
-         *
+         * @category Media
          * @param options The MailComposer options.
          * @returns Promise to the operation outcome.
          */
@@ -7097,6 +7143,7 @@
          *
          * 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.
          * @param variables Optional GraphQL variables.
@@ -7106,9 +7153,16 @@
         graphql(query, operationName, variables, options) {
             return this.post(this.fhirUrl('$graphql'), { query, operationName, variables }, JSON_CONTENT_TYPE, options);
         }
+        /**
+         * @category Authentication
+         * @returns The Login State
+         */
         getActiveLogin() {
             return __classPrivateFieldGet(this, _MedplumClient_storage, "f").getObject('activeLogin');
         }
+        /**
+         * @category Authentication
+         */
         setActiveLogin(login) {
             return __awaiter(this, void 0, void 0, function* () {
                 __classPrivateFieldSet(this, _MedplumClient_accessToken, login.accessToken, "f");
@@ -7122,25 +7176,43 @@
                 yield __classPrivateFieldGet(this, _MedplumClient_instances, "m", _MedplumClient_refreshProfile).call(this);
             });
         }
+        /**
+         * @category Authentication
+         */
         getAccessToken() {
             return __classPrivateFieldGet(this, _MedplumClient_accessToken, "f");
         }
+        /**
+         * @category Authentication
+         */
         setAccessToken(accessToken) {
             __classPrivateFieldSet(this, _MedplumClient_accessToken, accessToken, "f");
             __classPrivateFieldSet(this, _MedplumClient_refreshToken, undefined, "f");
             __classPrivateFieldSet(this, _MedplumClient_profile, undefined, "f");
             __classPrivateFieldSet(this, _MedplumClient_config, undefined, "f");
         }
+        /**
+         * @category Authentication
+         */
         getLogins() {
             var _a;
             return (_a = __classPrivateFieldGet(this, _MedplumClient_storage, "f").getObject('logins')) !== null && _a !== void 0 ? _a : [];
         }
+        /**
+         * @category Authentication
+         */
         isLoading() {
             return !!__classPrivateFieldGet(this, _MedplumClient_profilePromise, "f");
         }
+        /**
+         * @category User Profile
+         */
         getProfile() {
             return __classPrivateFieldGet(this, _MedplumClient_profile, "f");
         }
+        /**
+         * @category User Profile
+         */
         getProfileAsync() {
             return __awaiter(this, void 0, void 0, function* () {
                 if (__classPrivateFieldGet(this, _MedplumClient_profilePromise, "f")) {
@@ -7149,11 +7221,16 @@
                 return this.getProfile();
             });
         }
+        /**
+         * @category User Profile
+         */
         getUserConfiguration() {
             return __classPrivateFieldGet(this, _MedplumClient_config, "f");
         }
         /**
          * Downloads the URL as a blob.
+         *
+         * @category Read
          * @param url The URL to request.
          * @returns Promise to the response body as a blob.
          */
@@ -7194,6 +7271,7 @@
         /**
          * Starts a new OAuth2 client credentials flow.
          * See: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
+         * @category Authentication
          * @param clientId The client ID.
          * @param clientSecret The client secret.
          * @returns Promise that resolves to the client profile.
@@ -7401,6 +7479,7 @@
     };
     /**
      * Returns the base URL for the current page.
+     * @category HTTP
      */
     function getBaseUrl() {
         return window.location.protocol + '//' + window.location.host + '/';