@medplum/core 5.0.7 → 5.0.9

package/dist/cjs/index.d.ts

@@ -266,6 +266,8 @@ export declare function arrayBufferToBase64(arrayBuffer: ArrayBufferLike | Array
  */
 export declare function arrayBufferToHex(arrayBuffer: ArrayBufferLike | ArrayBufferView): string;
 
+export declare function arrayify<T>(value: NonNullable<T> | NonNullable<T>[]): T[];
+
 export declare function arrayify<T>(value: T | T[] | undefined): T[] | undefined;
 
 export declare class AsAtom extends InfixOperatorAtom {
@@ -629,6 +631,14 @@ export declare function checkIfValidMedplumVersion(appName: string, version: str
  */
 export declare function clearReleaseCache(): void;
 
+/**
+ * Log level for MedplumClient requests and responses.
+ * - 'none': No logging
+ * - 'basic': Log method, URL, and status code only (no sensitive headers)
+ * - 'verbose': Log all details including headers (may include sensitive data)
+ */
+export declare type ClientLogLevel = 'none' | 'basic' | 'verbose';
+
 /**
  * The ClientStorage class is a utility class for storing strings and objects.
  *
@@ -3406,6 +3416,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private initPromise;
     private initComplete;
     private keyValueClient?;
+    private logLevel;
     constructor(options?: MedplumClientOptions);
     /**
      * @returns Whether the client has been fully initialized or not. Should always be true unless a custom asynchronous `ClientStorage` was passed into the constructor.
@@ -3416,6 +3427,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns A Promise that resolves when any async initialization of the client is finished.
      */
     getInitPromise(): Promise<void>;
+    /**
+     * Initializes the log level with backward compatibility for the verbose option.
+     * @param options - The client options.
+     * @returns The initialized log level.
+     */
+    private initializeLogLevel;
     private attemptResumeActiveLogin;
     /**
      * Returns the current base URL for all API requests.
@@ -3869,6 +3886,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: MedplumRequestOptions): ReadablePromise<WithId<T>>;
+    readCanonical<RT extends ResourceType>(resourceType: RT | RT[], url: string, options?: MedplumRequestOptions): ReadablePromise<WithId<ExtractResource<RT>> | undefined>;
     /**
      * Requests the schema for a resource type.
      * If the schema is already cached, the promise is resolved immediately.
@@ -4788,10 +4806,46 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param clientSecret - The client secret.
      */
     setBasicAuth(clientId: string, clientSecret: string): void;
+    /**
+     * Sets the log level for the client.
+     * - 'none': No logging
+     * - 'basic': Log method, URL, and status code only (no sensitive headers)
+     * - 'verbose': Log all details including headers (may include sensitive data)
+     *
+     * @example
+     * ```typescript
+     * // Basic logging for production
+     * medplum.setLogLevel('basic');
+     * await medplum.searchResources('Patient');
+     * // Output:
+     * // > GET https://api.medplum.com/fhir/R4/Patient
+     * // < 200 OK
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Verbose logging for debugging
+     * medplum.setLogLevel('verbose');
+     * await medplum.searchResources('Patient');
+     * // Output includes all headers
+     * ```
+     *
+     * @category HTTP
+     * @param level - The log level to set.
+     */
+    setLogLevel(level: ClientLogLevel): void;
+    /**
+     * Gets the current log level.
+     * @category HTTP
+     * @returns The current log level.
+     */
+    getLogLevel(): ClientLogLevel;
     /**
      * Sets the verbose mode for the client.
      * When verbose is enabled, the client will log all requests and responses to the console.
      *
+     * @deprecated Use setLogLevel instead. This method will be removed in a future version.
+     *
      * @example
      * ```typescript
      * medplum.setVerbose(true);
@@ -5171,8 +5225,18 @@ export declare interface MedplumClientOptions {
     redirect?: RequestRedirect;
     /**
      * When the verbose flag is set, the client will log all requests and responses to the console.
+     * @deprecated Use logLevel instead. Will be removed in a future version.
      */
     verbose?: boolean;
+    /**
+     * Log level for requests and responses.
+     * - 'none': No logging (default)
+     * - 'basic': Log method, URL, and status code only (no sensitive headers)
+     * - 'verbose': Log all details including headers (may include sensitive data like tokens)
+     *
+     * @default 'none'
+     */
+    logLevel?: ClientLogLevel;
     /**
      * Optional flag to enable or disable Medplum extended mode.
      *
@@ -5901,6 +5965,14 @@ export declare class ParserBuilder {
      readonly value?: any;
  }
 
+ /**
+  * Translates a path emitted by this crawler into an RFC6902 JSON Patch pointer
+  *
+  * @param path - A path emitted from a Crawler
+  * @returns pointer -An RFC6902 pointer describing the path
+  */
+ export declare function pathToJSONPointer(path: string): string;
+
  export declare type PendingSubscriptionRequest = Omit<SubscriptionRequest, 'endpoint'>;
 
  /**
@@ -6298,6 +6370,30 @@ export declare class ParserBuilder {
   */
  export declare function reorderBundle(bundle: Bundle): Bundle;
 
+ /**
+  * Replaces prefetch query variables with values from the context or user profile.
+  *
+  * A prefetch token is a placeholder in a prefetch template that is *replaced by information from the hook's context*
+  * to construct the FHIR URL used to request the prefetch data.
+  *
+  * Prefetch tokens MUST be delimited by `{{` and `}}`, and MUST contain only the qualified path to a hook context field
+  * or one of the following user identifiers: `userPractitionerId`, `userPractitionerRoleId`, `userPatientId`, or `userRelatedPersonId`.
+  *
+  * Note that the spec says:
+  *
+  *   Individual hooks specify which of their `context` fields can be used as prefetch tokens.
+  *   Only root-level fields with a primitive value within the `context` object are eligible to be used as prefetch tokens.
+  *   For example, `{{context.medication.id}}` is not a valid prefetch token because it attempts to access the `id` field of the `medication` field.
+  *
+  * Unfortunately, many CDS Hooks services do not follow this rule. Therefore, this implementation allows access to nested fields.
+  *
+  * @param user - The user resource.
+  * @param context - The CDS request context.
+  * @param query - The prefetch query template.
+  * @returns The prefetch query with variables replaced.
+  */
+ export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
+
  export declare interface RequestProfileSchemaOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;

package/dist/esm/index.d.ts

@@ -266,6 +266,8 @@ export declare function arrayBufferToBase64(arrayBuffer: ArrayBufferLike | Array
  */
 export declare function arrayBufferToHex(arrayBuffer: ArrayBufferLike | ArrayBufferView): string;
 
+export declare function arrayify<T>(value: NonNullable<T> | NonNullable<T>[]): T[];
+
 export declare function arrayify<T>(value: T | T[] | undefined): T[] | undefined;
 
 export declare class AsAtom extends InfixOperatorAtom {
@@ -629,6 +631,14 @@ export declare function checkIfValidMedplumVersion(appName: string, version: str
  */
 export declare function clearReleaseCache(): void;
 
+/**
+ * Log level for MedplumClient requests and responses.
+ * - 'none': No logging
+ * - 'basic': Log method, URL, and status code only (no sensitive headers)
+ * - 'verbose': Log all details including headers (may include sensitive data)
+ */
+export declare type ClientLogLevel = 'none' | 'basic' | 'verbose';
+
 /**
  * The ClientStorage class is a utility class for storing strings and objects.
  *
@@ -3406,6 +3416,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private initPromise;
     private initComplete;
     private keyValueClient?;
+    private logLevel;
     constructor(options?: MedplumClientOptions);
     /**
      * @returns Whether the client has been fully initialized or not. Should always be true unless a custom asynchronous `ClientStorage` was passed into the constructor.
@@ -3416,6 +3427,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns A Promise that resolves when any async initialization of the client is finished.
      */
     getInitPromise(): Promise<void>;
+    /**
+     * Initializes the log level with backward compatibility for the verbose option.
+     * @param options - The client options.
+     * @returns The initialized log level.
+     */
+    private initializeLogLevel;
     private attemptResumeActiveLogin;
     /**
      * Returns the current base URL for all API requests.
@@ -3869,6 +3886,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: MedplumRequestOptions): ReadablePromise<WithId<T>>;
+    readCanonical<RT extends ResourceType>(resourceType: RT | RT[], url: string, options?: MedplumRequestOptions): ReadablePromise<WithId<ExtractResource<RT>> | undefined>;
     /**
      * Requests the schema for a resource type.
      * If the schema is already cached, the promise is resolved immediately.
@@ -4788,10 +4806,46 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param clientSecret - The client secret.
      */
     setBasicAuth(clientId: string, clientSecret: string): void;
+    /**
+     * Sets the log level for the client.
+     * - 'none': No logging
+     * - 'basic': Log method, URL, and status code only (no sensitive headers)
+     * - 'verbose': Log all details including headers (may include sensitive data)
+     *
+     * @example
+     * ```typescript
+     * // Basic logging for production
+     * medplum.setLogLevel('basic');
+     * await medplum.searchResources('Patient');
+     * // Output:
+     * // > GET https://api.medplum.com/fhir/R4/Patient
+     * // < 200 OK
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Verbose logging for debugging
+     * medplum.setLogLevel('verbose');
+     * await medplum.searchResources('Patient');
+     * // Output includes all headers
+     * ```
+     *
+     * @category HTTP
+     * @param level - The log level to set.
+     */
+    setLogLevel(level: ClientLogLevel): void;
+    /**
+     * Gets the current log level.
+     * @category HTTP
+     * @returns The current log level.
+     */
+    getLogLevel(): ClientLogLevel;
     /**
      * Sets the verbose mode for the client.
      * When verbose is enabled, the client will log all requests and responses to the console.
      *
+     * @deprecated Use setLogLevel instead. This method will be removed in a future version.
+     *
      * @example
      * ```typescript
      * medplum.setVerbose(true);
@@ -5171,8 +5225,18 @@ export declare interface MedplumClientOptions {
     redirect?: RequestRedirect;
     /**
      * When the verbose flag is set, the client will log all requests and responses to the console.
+     * @deprecated Use logLevel instead. Will be removed in a future version.
      */
     verbose?: boolean;
+    /**
+     * Log level for requests and responses.
+     * - 'none': No logging (default)
+     * - 'basic': Log method, URL, and status code only (no sensitive headers)
+     * - 'verbose': Log all details including headers (may include sensitive data like tokens)
+     *
+     * @default 'none'
+     */
+    logLevel?: ClientLogLevel;
     /**
      * Optional flag to enable or disable Medplum extended mode.
      *
@@ -5901,6 +5965,14 @@ export declare class ParserBuilder {
      readonly value?: any;
  }
 
+ /**
+  * Translates a path emitted by this crawler into an RFC6902 JSON Patch pointer
+  *
+  * @param path - A path emitted from a Crawler
+  * @returns pointer -An RFC6902 pointer describing the path
+  */
+ export declare function pathToJSONPointer(path: string): string;
+
  export declare type PendingSubscriptionRequest = Omit<SubscriptionRequest, 'endpoint'>;
 
  /**
@@ -6298,6 +6370,30 @@ export declare class ParserBuilder {
   */
  export declare function reorderBundle(bundle: Bundle): Bundle;
 
+ /**
+  * Replaces prefetch query variables with values from the context or user profile.
+  *
+  * A prefetch token is a placeholder in a prefetch template that is *replaced by information from the hook's context*
+  * to construct the FHIR URL used to request the prefetch data.
+  *
+  * Prefetch tokens MUST be delimited by `{{` and `}}`, and MUST contain only the qualified path to a hook context field
+  * or one of the following user identifiers: `userPractitionerId`, `userPractitionerRoleId`, `userPatientId`, or `userRelatedPersonId`.
+  *
+  * Note that the spec says:
+  *
+  *   Individual hooks specify which of their `context` fields can be used as prefetch tokens.
+  *   Only root-level fields with a primitive value within the `context` object are eligible to be used as prefetch tokens.
+  *   For example, `{{context.medication.id}}` is not a valid prefetch token because it attempts to access the `id` field of the `medication` field.
+  *
+  * Unfortunately, many CDS Hooks services do not follow this rule. Therefore, this implementation allows access to nested fields.
+  *
+  * @param user - The user resource.
+  * @param context - The CDS request context.
+  * @param query - The prefetch query template.
+  * @returns The prefetch query with variables replaced.
+  */
+ export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
+
  export declare interface RequestProfileSchemaOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;