@medplum/core 2.0.29 → 2.0.31

package/dist/types/access.d.ts

@@ -1,4 +1,4 @@
-import { AccessPolicy, Resource, ResourceType } from '@medplum/fhirtypes';
+import { AccessPolicy, AccessPolicyResource, Resource, ResourceType } from '@medplum/fhirtypes';
 /**
  * Public resource types are in the "public" project.
  * They are available to all users.
@@ -14,6 +14,31 @@ export declare const protectedResourceTypes: string[];
  * accessible to project administrators.
  */
 export declare const projectAdminResourceTypes: string[];
+/**
+ * Interactions with a resource that can be controlled via an access policy.
+ *
+ * Codes taken from http://hl7.org/fhir/codesystem-restful-interaction.html
+ */
+export declare enum AccessPolicyInteraction {
+    READ = "read",
+    VREAD = "vread",
+    UPDATE = "update",
+    PATCH = "patch",
+    DELETE = "delete",
+    HISTORY = "history",
+    HISTORY_INSTANCE = "history-instance",
+    HISTORY_TYPE = "history-type",
+    HISTORY_SYSTEM = "history-system",
+    CREATE = "create",
+    SEARCH = "search",
+    SEARCH_TYPE = "search-type",
+    SEARCH_SYSTEM = "search-system",
+    SEARCH_COMPARTMENT = "search-compartment",
+    CAPABILITIES = "capabilities",
+    TRANSACTION = "transaction",
+    BATCH = "batch",
+    OPERATION = "operation"
+}
 /**
  * Determines if the current user can read the specified resource type.
  * @param accessPolicy The access policy.
@@ -44,5 +69,14 @@ export declare function canWriteResource(accessPolicy: AccessPolicy, resource: R
  * @param resource The resource.
  * @param readonlyMode True if the resource is being read.
  * @returns True if the resource matches the access policy.
+ * @deprecated Use satisfiedAccessPolicy() instead.
  */
 export declare function matchesAccessPolicy(accessPolicy: AccessPolicy, resource: Resource, readonlyMode: boolean): boolean;
+/**
+ * Checks that there is an access policy permitting the given resource interaction, returning the matching policy object.
+ * @param resource The resource being acted upon.
+ * @param interaction The interaction being performed on the resource.
+ * @param accessPolicy The relevant access policy for the current user.
+ * @returns The satisfied access policy, or undefined if the access policy does not permit the given interaction.
+ */
+export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;

package/dist/types/client.d.ts

@@ -301,6 +301,10 @@ export interface PatchOperation {
     readonly path: string;
     readonly value?: any;
 }
+/**
+ * Source for a FHIR Binary.
+ */
+export type BinarySource = string | File | Blob | Uint8Array;
 /**
  * Email address definition.
  * Compatible with nodemailer Mail.Address.
@@ -1029,7 +1033,7 @@ export declare class MedplumClient extends EventTarget {
      * @param onProgress Optional callback for progress events.
      * @returns The result of the create operation.
      */
-    createAttachment(data: string | File | Blob | Uint8Array, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void): Promise<Attachment>;
+    createAttachment(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void): Promise<Attachment>;
     /**
      * Creates a FHIR `Binary` resource with the provided data content.
      *
@@ -1054,8 +1058,8 @@ export declare class MedplumClient extends EventTarget {
      * @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>;
-    uploadwithProgress(url: URL, data: string | File | Blob | Uint8Array, contentType: string, onProgress: (e: ProgressEvent) => void): Promise<any>;
+    createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void): Promise<Binary>;
+    uploadwithProgress(url: URL, data: BinarySource, contentType: string, onProgress: (e: ProgressEvent) => void): Promise<any>;
     /**
      * Creates a PDF as a FHIR `Binary` resource based on pdfmake document definition.
      *
@@ -1424,9 +1428,16 @@ export declare class MedplumClient extends EventTarget {
      */
     getAccessPolicy(): AccessPolicy | undefined;
     /**
-     * Downloads the URL as a blob.
+     * Translates/normalizes a URL so that it can be directly used with `MedplumClient.fetch`.
+     * Especially useful for translating `Binary/{id}` URLs to FHIR paths.
+     * @param url A valid URL within the `MedplumClient` context.
+     * @returns URL as a string that can be used with `MedplumClient.fetch`
+     */
+    normalizeFetchUrl(url: URL | string): string;
+    /**
+     * Downloads the URL as a blob. Can accept binary URLs in the form of `Binary/{id}` as well.
      * @category Read
-     * @param url The URL to request.
+     * @param url The URL to request. Can be a standard URL or one in the form of `Binary/{id}`.
      * @param options Optional fetch request init options.
      * @returns Promise to the response body as a blob.
      */

package/dist/types/config.d.ts

@@ -17,6 +17,7 @@ export interface MedplumInfraConfig {
     storageBucketName: string;
     storageDomainName: string;
     storageSslCertArn: string;
+    signingKeyId: string;
     storagePublicKey: string;
     storageLoggingBucket?: string;
     storageLoggingPrefix?: string;

package/dist/types/outcomes.d.ts

@@ -1,4 +1,5 @@
 import { OperationOutcome, OperationOutcomeIssue } from '@medplum/fhirtypes';
+import { Constraint } from './typeschema/types';
 export declare const allOk: OperationOutcome;
 export declare const created: OperationOutcome;
 export declare const notModified: OperationOutcome;
@@ -51,3 +52,6 @@ export declare function operationOutcomeToString(outcome: OperationOutcome): str
  * @returns The string representation of the operation outcome issue.
  */
 export declare function operationOutcomeIssueToString(issue: OperationOutcomeIssue): string;
+export declare function createStructureIssue(expression: string, details: string): OperationOutcomeIssue;
+export declare function createConstraintIssue(expression: string, constraint: Constraint): OperationOutcomeIssue;
+export declare function createProcessingIssue(expression: string, message: string, err: Error, data?: Record<string, any>): OperationOutcomeIssue;

package/dist/types/schema.d.ts

@@ -144,4 +144,3 @@ export declare class FhirSchemaValidator<T extends Resource> {
  * @param issues Output list of issues.
  */
 export declare function checkForNull(value: unknown, path: string, issues: OperationOutcomeIssue[]): void;
-export declare function createStructureIssue(expression: string, details: string): OperationOutcomeIssue;

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

@@ -11,13 +11,12 @@ export interface SearchRequest<T extends Resource = Resource> {
     total?: 'none' | 'estimate' | 'accurate';
     include?: IncludeTarget[];
     revInclude?: IncludeTarget[];
+    summary?: 'true' | 'text' | 'data';
 }
 export interface Filter {
     code: string;
     operator: Operator;
     value: string;
-    unitSystem?: string;
-    unitCode?: string;
 }
 export interface SortRule {
     code: string;

package/dist/types/typeschema/types.d.ts

@@ -1,4 +1,4 @@
-import { Bundle, StructureDefinition } from '@medplum/fhirtypes';
+import { Bundle, StructureDefinition, Resource } from '@medplum/fhirtypes';
 import { TypedValue } from '../types';
 /**
  * Internal representation of a non-primitive FHIR type, suitable for use in resource validation
@@ -8,6 +8,8 @@ export interface InternalTypeSchema {
     fields: Record<string, ElementValidator>;
     constraints: Constraint[];
     innerTypes: InternalTypeSchema[];
+    summaryProperties?: Set<string>;
+    mandatoryProperties?: Set<string>;
 }
 export interface ElementValidator {
     min: number;
@@ -38,6 +40,7 @@ export interface SlicingRules {
 }
 export interface SliceDefinition {
     name: string;
+    type?: ElementType[];
     fields: Record<string, ElementValidator>;
     min: number;
     max: number;
@@ -56,3 +59,12 @@ export interface SliceDiscriminator {
 export declare function parseStructureDefinition(sd: StructureDefinition): InternalTypeSchema;
 export declare function loadDataTypes(bundle: Bundle<StructureDefinition>): void;
 export declare function getDataType(type: string): InternalTypeSchema;
+/**
+ * Construct the subset of a resource containing a minimum set of fields.  The returned resource is not guaranteed
+ * to contain only the provided properties, and may contain others (e.g. `resourceType` and `id`)
+ *
+ * @param resource The resource to subset
+ * @param properties The minimum properties to include in the subset
+ * @returns The modified resource, containing the listed properties and possibly other mandatory ones
+ */
+export declare function subsetResource<T extends Resource>(resource: T | undefined, properties: string[]): T | undefined;

package/dist/types/utils.d.ts

@@ -1,4 +1,4 @@
-import { CodeableConcept, Extension, ObservationDefinition, ObservationDefinitionQualifiedInterval, Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Range, Reference, RelatedPerson, Resource } from '@medplum/fhirtypes';
+import { CodeableConcept, Extension, ObservationDefinition, ObservationDefinitionQualifiedInterval, Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Range, Reference, RelatedPerson, Resource, ResourceType } from '@medplum/fhirtypes';
 /**
  * @internal
  */
@@ -28,6 +28,13 @@ export declare function getReferenceString(resource: Resource): string;
  * @returns The ID portion of a reference.
  */
 export declare function resolveId(reference: Reference | undefined): string | undefined;
+/**
+ * Parses a reference and returns a tuple of [ResourceType, ID].
+ * @param reference A reference to a FHIR resource.
+ * @returns A tuple containing the `ResourceType` and the ID of the resource or `undefined` when `undefined` or an invalid reference is passed.
+ */
+export declare function parseReference(reference: Reference): [ResourceType, string] | undefined;
+export declare function parseReference(reference: undefined): undefined;
 /**
  * Returns true if the resource is a "ProfileResource".
  * @param resource The FHIR resource.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "2.0.29",
+  "version": "2.0.31",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",