@medplum/core 3.0.11 → 3.0.12

package/dist/cjs/index.d.ts

@@ -482,6 +482,32 @@ export declare const CPT = "http://www.ama-assn.org/go/cpt";
 
 export declare function crawlResource(resource: Resource, visitor: ResourceVisitor, schema?: InternalTypeSchema, initialPath?: string): void;
 
+/**
+ * Binary upload options.
+ */
+export declare interface CreateBinaryOptions {
+    /**
+     * The binary data to upload.
+     */
+    readonly data: BinarySource;
+    /**
+     * Content type for the binary.
+     */
+    readonly contentType: string;
+    /**
+     * Optional filename for the binary.
+     */
+    readonly filename?: string;
+    /**
+     * Optional security context for the binary.
+     */
+    readonly securityContext?: Reference;
+    /**
+     * Optional fetch options. **NOTE:** only `requestOptions.signal` is respected when `onProgress` is also provided.
+     */
+    readonly onProgress?: (e: ProgressEvent) => void;
+}
+
 export declare function createConstraintIssue(expression: string, constraint: Constraint): OperationOutcomeIssue;
 
 export declare const created: OperationOutcome;
@@ -499,12 +525,37 @@ export declare function createFhircastMessagePayload<EventName extends FhircastE
 
 export declare function createFhircastMessagePayload<EventName extends FhircastEventVersionRequired>(topic: string, event: EventName, context: FhircastValidContextForEvent<EventName> | FhircastValidContextForEvent<EventName>[], versionId: string): FhircastMessagePayload<EventName>;
 
+export declare interface CreateMediaOptions extends CreateBinaryOptions {
+    /**
+     * Optional additional fields for the Media resource.
+     */
+    readonly additionalFields?: Partial<Media>;
+}
+
 export declare function createOperationOutcomeIssue(severity: IssueSeverity, code: IssueType, message: string, path: string, data?: Record<string, any>): OperationOutcomeIssue;
 
 export declare interface CreatePdfFunction {
     (docDefinition: TDocumentDefinitions, tableLayouts?: Record<string, CustomTableLayout> | undefined, fonts?: TFontDictionary | undefined): Promise<any>;
 }
 
+/**
+ * PDF upload options.
+ */
+export declare interface CreatePdfOptions extends Omit<CreateBinaryOptions, 'data' | 'contentType'> {
+    /**
+     * The PDF document definition. See https://pdfmake.github.io/docs/0.1/document-definition-object/
+     */
+    readonly docDefinition: TDocumentDefinitions;
+    /**
+     * Optional pdfmake custom table layout.
+     */
+    readonly tableLayouts?: Record<string, CustomTableLayout>;
+    /**
+     * Optional pdfmake custom font dictionary.
+     */
+    readonly fonts?: TFontDictionary;
+}
+
 export declare function createProcessingIssue(expression: string, message: string, err: Error, data?: Record<string, any>): OperationOutcomeIssue;
 
 /**
@@ -2290,6 +2341,8 @@ export declare function matchesRange(value: number, range: Range_2, precision?:
  */
 export declare function matchesSearchRequest(resource: Resource, searchRequest: SearchRequest): boolean;
 
+export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
+
 export declare const MEDPLUM_VERSION: any;
 
 /**
@@ -2997,6 +3050,13 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createAttachment(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<Attachment>;
+    /**
      * @category Create
      * @param data - The binary data to upload.
      * @param filename - Optional filename for the binary.
@@ -3004,6 +3064,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @returns The result of the create operation.
+     * @deprecated Use `createAttachment` with `CreateBinaryOptions` instead. To be removed in Medplum 4.0.
      */
     createAttachment(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<Attachment>;
     /**
@@ -3024,6 +3085,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createBinary(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<Binary>;
+    /**
      * @category Create
      * @param data - The binary data to upload.
      * @param filename - Optional filename for the binary.
@@ -3031,6 +3100,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @returns The result of the create operation.
+     * @deprecated Use `createBinary` with `CreateBinaryOptions` instead. To be removed in Medplum 4.0.
      */
     createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<Binary>;
     uploadwithProgress(url: URL, data: BinarySource, contentType: string, onProgress: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<any>;
@@ -3052,14 +3122,22 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
+     * @category Media
+     * @param createPdfOptions - The PDF creation options. See `CreatePdfOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The result of the create operation.
+     */
+    createPdf(createPdfOptions: CreatePdfOptions, requestOptions?: MedplumRequestOptions): Promise<Binary>;
+    /**
      * @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.
+     * @deprecated Use `createPdf` with `CreatePdfOptions` instead. To be removed in Medplum 4.0.
      */
-    createPdf(docDefinition: TDocumentDefinitions, filename?: string, tableLayouts?: Record<string, CustomTableLayout>, fonts?: TFontDictionary): Promise<Binary>;
+    createPdf(docDefinition: TDocumentDefinitions, filename: string | undefined, tableLayouts?: Record<string, CustomTableLayout>, fonts?: TFontDictionary): Promise<Binary>;
     /**
      * Creates a FHIR `Communication` resource with the provided data content.
      *
@@ -3430,14 +3508,24 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns Promise to the response body as a blob.
      */
     download(url: URL | string, options?: MedplumRequestOptions): Promise<Blob>;
+    /**
+     * Creates a FHIR Media resource with the provided data content.
+     *
+     * @category Create
+     * @param createMediaOptions - The media creation options. See `CreateMediaOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The new media resource.
+     */
+    createMedia(createMediaOptions: CreateMediaOptions, requestOptions?: MedplumRequestOptions): Promise<Media>;
     /**
      * 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 filename - Optional filename for the binary, or extended upload options (see `BinaryUploadOptions`).
      * @param additionalFields - Additional fields for Media.
      * @param options - Optional fetch options.
      * @returns Promise that resolves to the created Media
+     * @deprecated Use `createMedia` with `CreateMediaOptions` instead. To be removed in Medplum 4.0.
      */
     uploadMedia(contents: string | Uint8Array | File | Blob, contentType: string, filename: string | undefined, additionalFields?: Partial<Media>, options?: MedplumRequestOptions): Promise<Media>;
     /**
@@ -3516,6 +3604,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param contentType - The new content type to set.
      */
     private setRequestContentType;
+    /**
+     * Sets a header on fetch options.
+     * @param options - The fetch options.
+     * @param key - The header key.
+     * @param value - The header value.
+     * @param ifNoneExist - Optional flag to only set the header if it doesn't already exist.
+     */
+    private setRequestHeader;
     /**
      * Sets the body on fetch options.
      * @param options - The fetch options.
@@ -4208,6 +4304,10 @@ export declare interface NewUserRequest {
     readonly clientId?: string;
 }
 
+export declare function normalizeCreateBinaryOptions(arg1: BinarySource | CreateBinaryOptions, arg2: string | undefined | MedplumRequestOptions, arg3?: string, arg4?: (e: ProgressEvent) => void): CreateBinaryOptions;
+
+export declare function normalizeCreatePdfOptions(arg1: TDocumentDefinitions | CreatePdfOptions, arg2: string | undefined | MedplumRequestOptions, arg3: Record<string, CustomTableLayout> | undefined, arg4: TFontDictionary | undefined): CreatePdfOptions;
+
 /**
  * Normalizes an error object into a displayable error string.
  * @param error - The error value which could be a string, Error, OperationOutcome, or other unknown type.
@@ -4473,7 +4573,7 @@ export declare class ParserBuilder {
  * @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 | undefined): [ResourceType, string];
+export declare function parseReference<T extends Resource>(reference: Reference<T> | undefined): [T['resourceType'], string];
 
 /**
  * Parses a URL string into a SearchRequest.

package/dist/esm/index.d.ts

@@ -482,6 +482,32 @@ export declare const CPT = "http://www.ama-assn.org/go/cpt";
 
 export declare function crawlResource(resource: Resource, visitor: ResourceVisitor, schema?: InternalTypeSchema, initialPath?: string): void;
 
+/**
+ * Binary upload options.
+ */
+export declare interface CreateBinaryOptions {
+    /**
+     * The binary data to upload.
+     */
+    readonly data: BinarySource;
+    /**
+     * Content type for the binary.
+     */
+    readonly contentType: string;
+    /**
+     * Optional filename for the binary.
+     */
+    readonly filename?: string;
+    /**
+     * Optional security context for the binary.
+     */
+    readonly securityContext?: Reference;
+    /**
+     * Optional fetch options. **NOTE:** only `requestOptions.signal` is respected when `onProgress` is also provided.
+     */
+    readonly onProgress?: (e: ProgressEvent) => void;
+}
+
 export declare function createConstraintIssue(expression: string, constraint: Constraint): OperationOutcomeIssue;
 
 export declare const created: OperationOutcome;
@@ -499,12 +525,37 @@ export declare function createFhircastMessagePayload<EventName extends FhircastE
 
 export declare function createFhircastMessagePayload<EventName extends FhircastEventVersionRequired>(topic: string, event: EventName, context: FhircastValidContextForEvent<EventName> | FhircastValidContextForEvent<EventName>[], versionId: string): FhircastMessagePayload<EventName>;
 
+export declare interface CreateMediaOptions extends CreateBinaryOptions {
+    /**
+     * Optional additional fields for the Media resource.
+     */
+    readonly additionalFields?: Partial<Media>;
+}
+
 export declare function createOperationOutcomeIssue(severity: IssueSeverity, code: IssueType, message: string, path: string, data?: Record<string, any>): OperationOutcomeIssue;
 
 export declare interface CreatePdfFunction {
     (docDefinition: TDocumentDefinitions, tableLayouts?: Record<string, CustomTableLayout> | undefined, fonts?: TFontDictionary | undefined): Promise<any>;
 }
 
+/**
+ * PDF upload options.
+ */
+export declare interface CreatePdfOptions extends Omit<CreateBinaryOptions, 'data' | 'contentType'> {
+    /**
+     * The PDF document definition. See https://pdfmake.github.io/docs/0.1/document-definition-object/
+     */
+    readonly docDefinition: TDocumentDefinitions;
+    /**
+     * Optional pdfmake custom table layout.
+     */
+    readonly tableLayouts?: Record<string, CustomTableLayout>;
+    /**
+     * Optional pdfmake custom font dictionary.
+     */
+    readonly fonts?: TFontDictionary;
+}
+
 export declare function createProcessingIssue(expression: string, message: string, err: Error, data?: Record<string, any>): OperationOutcomeIssue;
 
 /**
@@ -2290,6 +2341,8 @@ export declare function matchesRange(value: number, range: Range_2, precision?:
  */
 export declare function matchesSearchRequest(resource: Resource, searchRequest: SearchRequest): boolean;
 
+export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
+
 export declare const MEDPLUM_VERSION: any;
 
 /**
@@ -2997,6 +3050,13 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createAttachment(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<Attachment>;
+    /**
      * @category Create
      * @param data - The binary data to upload.
      * @param filename - Optional filename for the binary.
@@ -3004,6 +3064,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @returns The result of the create operation.
+     * @deprecated Use `createAttachment` with `CreateBinaryOptions` instead. To be removed in Medplum 4.0.
      */
     createAttachment(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<Attachment>;
     /**
@@ -3024,6 +3085,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createBinary(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<Binary>;
+    /**
      * @category Create
      * @param data - The binary data to upload.
      * @param filename - Optional filename for the binary.
@@ -3031,6 +3100,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
      * @returns The result of the create operation.
+     * @deprecated Use `createBinary` with `CreateBinaryOptions` instead. To be removed in Medplum 4.0.
      */
     createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<Binary>;
     uploadwithProgress(url: URL, data: BinarySource, contentType: string, onProgress: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<any>;
@@ -3052,14 +3122,22 @@ export declare class MedplumClient extends EventTarget_2 {
      * ```
      *
      * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
+     * @category Media
+     * @param createPdfOptions - The PDF creation options. See `CreatePdfOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The result of the create operation.
+     */
+    createPdf(createPdfOptions: CreatePdfOptions, requestOptions?: MedplumRequestOptions): Promise<Binary>;
+    /**
      * @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.
+     * @deprecated Use `createPdf` with `CreatePdfOptions` instead. To be removed in Medplum 4.0.
      */
-    createPdf(docDefinition: TDocumentDefinitions, filename?: string, tableLayouts?: Record<string, CustomTableLayout>, fonts?: TFontDictionary): Promise<Binary>;
+    createPdf(docDefinition: TDocumentDefinitions, filename: string | undefined, tableLayouts?: Record<string, CustomTableLayout>, fonts?: TFontDictionary): Promise<Binary>;
     /**
      * Creates a FHIR `Communication` resource with the provided data content.
      *
@@ -3430,14 +3508,24 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns Promise to the response body as a blob.
      */
     download(url: URL | string, options?: MedplumRequestOptions): Promise<Blob>;
+    /**
+     * Creates a FHIR Media resource with the provided data content.
+     *
+     * @category Create
+     * @param createMediaOptions - The media creation options. See `CreateMediaOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The new media resource.
+     */
+    createMedia(createMediaOptions: CreateMediaOptions, requestOptions?: MedplumRequestOptions): Promise<Media>;
     /**
      * 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 filename - Optional filename for the binary, or extended upload options (see `BinaryUploadOptions`).
      * @param additionalFields - Additional fields for Media.
      * @param options - Optional fetch options.
      * @returns Promise that resolves to the created Media
+     * @deprecated Use `createMedia` with `CreateMediaOptions` instead. To be removed in Medplum 4.0.
      */
     uploadMedia(contents: string | Uint8Array | File | Blob, contentType: string, filename: string | undefined, additionalFields?: Partial<Media>, options?: MedplumRequestOptions): Promise<Media>;
     /**
@@ -3516,6 +3604,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param contentType - The new content type to set.
      */
     private setRequestContentType;
+    /**
+     * Sets a header on fetch options.
+     * @param options - The fetch options.
+     * @param key - The header key.
+     * @param value - The header value.
+     * @param ifNoneExist - Optional flag to only set the header if it doesn't already exist.
+     */
+    private setRequestHeader;
     /**
      * Sets the body on fetch options.
      * @param options - The fetch options.
@@ -4208,6 +4304,10 @@ export declare interface NewUserRequest {
     readonly clientId?: string;
 }
 
+export declare function normalizeCreateBinaryOptions(arg1: BinarySource | CreateBinaryOptions, arg2: string | undefined | MedplumRequestOptions, arg3?: string, arg4?: (e: ProgressEvent) => void): CreateBinaryOptions;
+
+export declare function normalizeCreatePdfOptions(arg1: TDocumentDefinitions | CreatePdfOptions, arg2: string | undefined | MedplumRequestOptions, arg3: Record<string, CustomTableLayout> | undefined, arg4: TFontDictionary | undefined): CreatePdfOptions;
+
 /**
  * Normalizes an error object into a displayable error string.
  * @param error - The error value which could be a string, Error, OperationOutcome, or other unknown type.
@@ -4473,7 +4573,7 @@ export declare class ParserBuilder {
  * @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 | undefined): [ResourceType, string];
+export declare function parseReference<T extends Resource>(reference: Reference<T> | undefined): [T['resourceType'], string];
 
 /**
  * Parses a URL string into a SearchRequest.