@medplum/core 4.1.9 → 4.1.11

package/dist/cjs/index.d.ts

@@ -72,25 +72,25 @@ export declare const AccessPolicyInteraction: {
     readonly READ: "read";
     readonly VREAD: "vread";
     readonly UPDATE: "update";
-    readonly PATCH: "patch";
     readonly DELETE: "delete";
     readonly HISTORY: "history";
-    readonly HISTORY_INSTANCE: "history-instance";
-    readonly HISTORY_TYPE: "history-type";
-    readonly HISTORY_SYSTEM: "history-system";
     readonly CREATE: "create";
     readonly SEARCH: "search";
-    readonly SEARCH_TYPE: "search-type";
-    readonly SEARCH_SYSTEM: "search-system";
-    readonly SEARCH_COMPARTMENT: "search-compartment";
-    readonly CAPABILITIES: "capabilities";
-    readonly TRANSACTION: "transaction";
-    readonly BATCH: "batch";
-    readonly OPERATION: "operation";
 };
 
 export declare type AccessPolicyInteraction = (typeof AccessPolicyInteraction)[keyof typeof AccessPolicyInteraction];
 
+/**
+ * Shallow check that an interaction is permitted by the AccessPolicy on a given resource type,
+ * at least for some resources.  A more in-depth check for the specific resource(s) being accessed
+ * is required in addition to this one.
+ * @param accessPolicy - The AccessPolicy to check against.
+ * @param interaction - The FHIR interaction being performed.
+ * @param resourceType - The type of resource being interacted with.
+ * @returns True when the interaction is provisionally permitted by the AccessPolicy.
+ */
+export declare function accessPolicySupportsInteraction(accessPolicy: AccessPolicy, interaction: AccessPolicyInteraction, resourceType: ResourceType): boolean;
+
 export declare const AckCode: {
     /** AA - Application Accept */
     readonly AA: "AA";
@@ -406,6 +406,7 @@ export declare type CanBePopulated = {
  * @param accessPolicy - The access policy.
  * @param resourceType - The resource type.
  * @returns True if the current user can read the specified resource type.
+ * @deprecated Use accessPolicySupportsInteraction() instead.
  */
 export declare function canReadResourceType(accessPolicy: AccessPolicy, resourceType: ResourceType): boolean;
 
@@ -415,6 +416,7 @@ export declare function canReadResourceType(accessPolicy: AccessPolicy, resource
  * @param accessPolicy - The access policy.
  * @param resource - The resource.
  * @returns True if the current user can write the specified resource type.
+ * @deprecated Use satisfiedAccessPolicy() instead.
  */
 export declare function canWriteResource(accessPolicy: AccessPolicy, resource: Resource): boolean;
 
@@ -425,6 +427,7 @@ export declare function canWriteResource(accessPolicy: AccessPolicy, resource: R
  * @param accessPolicy - The access policy.
  * @param resourceType - The resource type.
  * @returns True if the current user can write the specified resource type.
+ * @deprecated Use accessPolicySupportsInteraction() instead.
  */
 export declare function canWriteResourceType(accessPolicy: AccessPolicy, resourceType: ResourceType): boolean;
 
@@ -555,6 +558,7 @@ export declare const ContentType: {
     readonly JAVASCRIPT: "text/javascript";
     readonly JSON: "application/json";
     readonly JSON_PATCH: "application/json-patch+json";
+    readonly JWT: "application/jwt";
     readonly MULTIPART_FORM_DATA: "multipart/form-data";
     readonly PNG: "image/png";
     readonly SCIM_JSON: "application/scim+json";
@@ -728,6 +732,15 @@ export declare type CurrentContext<T extends FhircastAnchorResourceType | '' = F
     context: FhircastEventContext<AnchorResourceOpenEvent<T>>[];
 } : never;
 
+export declare interface DataSampleOptions {
+    /** Code for the data points. */
+    code?: CodeableConcept;
+    /** Unit for the data points. */
+    unit?: QuantityUnit;
+    /** Sampling information for high-frequency Observations. */
+    sampling?: Omit<SampledData, 'data'>;
+}
+
 export declare class DataSampler {
     private code?;
     private unit?;
@@ -735,15 +748,8 @@ export declare class DataSampler {
     private readonly dataPoints;
     /**
      * @param opts - Optional parameters.
-     * @param opts.code - Code for data points.
-     * @param opts.unit - Unit for data points.
-     * @param opts.sampling - Sampling information for high-frequency Observations.
-     */
-    constructor(opts?: {
-        code?: CodeableConcept;
-        unit?: QuantityUnit;
-        sampling?: SamplingInfo;
-    });
+     */
+    constructor(opts?: DataSampleOptions);
     addObservation(obs: Observation): void;
     addData(...data: number[]): void;
     private checkUnit;
@@ -2465,6 +2471,15 @@ export declare function isDateTimeString(input: unknown): input is string;
  */
 export declare function isEmpty(v: unknown): boolean;
 
+/**
+ * Returns true if the input is an Error object.
+ * This should be replaced with `Error.isError` when it is more widely supported.
+ * See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError
+ * @param value - The candidate value.
+ * @returns True if the input is an Error object.
+ */
+export declare function isError(value: unknown): value is Error;
+
 /**
  * Checks if a `ResourceType` can be used in a `FHIRcast` context.
  *
@@ -5702,6 +5717,8 @@ export declare class ReadablePromise<T> implements Promise<T> {
     finally(onfinally?: (() => void) | null): Promise<T>;
 }
 
+export declare const readInteractions: AccessPolicyInteraction[];
+
 export declare class ReconnectingWebSocket<WS extends IWebSocket = WebSocket> extends TypedEventTarget<WebSocketEventMap_2> implements IReconnectingWebSocket {
     private _ws;
     private _retryCount;

package/dist/esm/index.d.ts

@@ -72,25 +72,25 @@ export declare const AccessPolicyInteraction: {
     readonly READ: "read";
     readonly VREAD: "vread";
     readonly UPDATE: "update";
-    readonly PATCH: "patch";
     readonly DELETE: "delete";
     readonly HISTORY: "history";
-    readonly HISTORY_INSTANCE: "history-instance";
-    readonly HISTORY_TYPE: "history-type";
-    readonly HISTORY_SYSTEM: "history-system";
     readonly CREATE: "create";
     readonly SEARCH: "search";
-    readonly SEARCH_TYPE: "search-type";
-    readonly SEARCH_SYSTEM: "search-system";
-    readonly SEARCH_COMPARTMENT: "search-compartment";
-    readonly CAPABILITIES: "capabilities";
-    readonly TRANSACTION: "transaction";
-    readonly BATCH: "batch";
-    readonly OPERATION: "operation";
 };
 
 export declare type AccessPolicyInteraction = (typeof AccessPolicyInteraction)[keyof typeof AccessPolicyInteraction];
 
+/**
+ * Shallow check that an interaction is permitted by the AccessPolicy on a given resource type,
+ * at least for some resources.  A more in-depth check for the specific resource(s) being accessed
+ * is required in addition to this one.
+ * @param accessPolicy - The AccessPolicy to check against.
+ * @param interaction - The FHIR interaction being performed.
+ * @param resourceType - The type of resource being interacted with.
+ * @returns True when the interaction is provisionally permitted by the AccessPolicy.
+ */
+export declare function accessPolicySupportsInteraction(accessPolicy: AccessPolicy, interaction: AccessPolicyInteraction, resourceType: ResourceType): boolean;
+
 export declare const AckCode: {
     /** AA - Application Accept */
     readonly AA: "AA";
@@ -406,6 +406,7 @@ export declare type CanBePopulated = {
  * @param accessPolicy - The access policy.
  * @param resourceType - The resource type.
  * @returns True if the current user can read the specified resource type.
+ * @deprecated Use accessPolicySupportsInteraction() instead.
  */
 export declare function canReadResourceType(accessPolicy: AccessPolicy, resourceType: ResourceType): boolean;
 
@@ -415,6 +416,7 @@ export declare function canReadResourceType(accessPolicy: AccessPolicy, resource
  * @param accessPolicy - The access policy.
  * @param resource - The resource.
  * @returns True if the current user can write the specified resource type.
+ * @deprecated Use satisfiedAccessPolicy() instead.
  */
 export declare function canWriteResource(accessPolicy: AccessPolicy, resource: Resource): boolean;
 
@@ -425,6 +427,7 @@ export declare function canWriteResource(accessPolicy: AccessPolicy, resource: R
  * @param accessPolicy - The access policy.
  * @param resourceType - The resource type.
  * @returns True if the current user can write the specified resource type.
+ * @deprecated Use accessPolicySupportsInteraction() instead.
  */
 export declare function canWriteResourceType(accessPolicy: AccessPolicy, resourceType: ResourceType): boolean;
 
@@ -555,6 +558,7 @@ export declare const ContentType: {
     readonly JAVASCRIPT: "text/javascript";
     readonly JSON: "application/json";
     readonly JSON_PATCH: "application/json-patch+json";
+    readonly JWT: "application/jwt";
     readonly MULTIPART_FORM_DATA: "multipart/form-data";
     readonly PNG: "image/png";
     readonly SCIM_JSON: "application/scim+json";
@@ -728,6 +732,15 @@ export declare type CurrentContext<T extends FhircastAnchorResourceType | '' = F
     context: FhircastEventContext<AnchorResourceOpenEvent<T>>[];
 } : never;
 
+export declare interface DataSampleOptions {
+    /** Code for the data points. */
+    code?: CodeableConcept;
+    /** Unit for the data points. */
+    unit?: QuantityUnit;
+    /** Sampling information for high-frequency Observations. */
+    sampling?: Omit<SampledData, 'data'>;
+}
+
 export declare class DataSampler {
     private code?;
     private unit?;
@@ -735,15 +748,8 @@ export declare class DataSampler {
     private readonly dataPoints;
     /**
      * @param opts - Optional parameters.
-     * @param opts.code - Code for data points.
-     * @param opts.unit - Unit for data points.
-     * @param opts.sampling - Sampling information for high-frequency Observations.
-     */
-    constructor(opts?: {
-        code?: CodeableConcept;
-        unit?: QuantityUnit;
-        sampling?: SamplingInfo;
-    });
+     */
+    constructor(opts?: DataSampleOptions);
     addObservation(obs: Observation): void;
     addData(...data: number[]): void;
     private checkUnit;
@@ -2465,6 +2471,15 @@ export declare function isDateTimeString(input: unknown): input is string;
  */
 export declare function isEmpty(v: unknown): boolean;
 
+/**
+ * Returns true if the input is an Error object.
+ * This should be replaced with `Error.isError` when it is more widely supported.
+ * See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError
+ * @param value - The candidate value.
+ * @returns True if the input is an Error object.
+ */
+export declare function isError(value: unknown): value is Error;
+
 /**
  * Checks if a `ResourceType` can be used in a `FHIRcast` context.
  *
@@ -5702,6 +5717,8 @@ export declare class ReadablePromise<T> implements Promise<T> {
     finally(onfinally?: (() => void) | null): Promise<T>;
 }
 
+export declare const readInteractions: AccessPolicyInteraction[];
+
 export declare class ReconnectingWebSocket<WS extends IWebSocket = WebSocket> extends TypedEventTarget<WebSocketEventMap_2> implements IReconnectingWebSocket {
     private _ws;
     private _retryCount;