@medplum/core 5.2.8 → 5.2.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +7 -7
- package/dist/cjs/index.cjs.map +3 -3
- package/dist/cjs/index.d.ts +40 -4
- package/dist/esm/index.d.ts +40 -4
- package/dist/esm/index.mjs +6 -6
- package/dist/esm/index.mjs.map +3 -3
- package/package.json +3 -3
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1633,6 +1633,18 @@ export { ErrorEvent_2 as ErrorEvent }
|
|
|
1633
1633
|
*/
|
|
1634
1634
|
export declare function escapeHtml(unsafe: string): string;
|
|
1635
1635
|
|
|
1636
|
+
/**
|
|
1637
|
+
* Escapes a literal string for use as a single FHIR search value.
|
|
1638
|
+
* Backslash-escapes commas and backslashes, so that the value is not split into multiple "or" values.
|
|
1639
|
+
* This is the inverse of `splitSearchOnComma`.
|
|
1640
|
+
*
|
|
1641
|
+
* See: https://hl7.org/fhir/r4/search.html#escaping
|
|
1642
|
+
*
|
|
1643
|
+
* @param input - The literal string to search for.
|
|
1644
|
+
* @returns The escaped FHIR search value.
|
|
1645
|
+
*/
|
|
1646
|
+
export declare function escapeSearchValue(input: string): string;
|
|
1647
|
+
|
|
1636
1648
|
/**
|
|
1637
1649
|
* Escape token part of a JSON Pointer string
|
|
1638
1650
|
*
|
|
@@ -4287,16 +4299,23 @@ export declare interface MailAddress {
|
|
|
4287
4299
|
/**
|
|
4288
4300
|
* Email attachment definition.
|
|
4289
4301
|
* Compatible with nodemailer Mail.Options.
|
|
4302
|
+
* Other nodemailer attachment options are ignored by the Medplum server.
|
|
4290
4303
|
*/
|
|
4291
4304
|
export declare interface MailAttachment {
|
|
4292
|
-
/** String
|
|
4305
|
+
/** String contents for the attachment */
|
|
4293
4306
|
readonly content?: string;
|
|
4294
|
-
/**
|
|
4307
|
+
/** A `Binary/{id}` reference, an HTTPS URL, or a data URI, if you want to stream the file instead of including it (better for larger attachments). Local file paths are not allowed. */
|
|
4295
4308
|
readonly path?: string;
|
|
4296
4309
|
/** filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value as false, otherwise a filename is generated automatically */
|
|
4297
4310
|
readonly filename?: string | false;
|
|
4298
4311
|
/** optional content type for the attachment, if not set will be derived from the filename property */
|
|
4299
4312
|
readonly contentType?: string;
|
|
4313
|
+
/** optional content disposition type for the attachment, defaults to 'attachment' */
|
|
4314
|
+
readonly contentDisposition?: string;
|
|
4315
|
+
/** optional content id for using inline images in HTML message source */
|
|
4316
|
+
readonly cid?: string;
|
|
4317
|
+
/** If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: 'base64', 'hex', 'binary' etc. */
|
|
4318
|
+
readonly encoding?: string;
|
|
4300
4319
|
}
|
|
4301
4320
|
|
|
4302
4321
|
/**
|
|
@@ -4304,14 +4323,28 @@ export declare interface MailAttachment {
|
|
|
4304
4323
|
*/
|
|
4305
4324
|
export declare type MailDestination = string | MailAddress | string[] | MailAddress[];
|
|
4306
4325
|
|
|
4326
|
+
/**
|
|
4327
|
+
* Email calendar event definition.
|
|
4328
|
+
* Compatible with nodemailer Mail.IcalAttachment.
|
|
4329
|
+
*/
|
|
4330
|
+
export declare interface MailIcalEvent {
|
|
4331
|
+
/** Method of the calendar event, for example 'REQUEST' or 'CANCEL' */
|
|
4332
|
+
readonly method?: string;
|
|
4333
|
+
/** Filename of the calendar event attachment */
|
|
4334
|
+
readonly filename?: string;
|
|
4335
|
+
/** iCalendar contents of the event */
|
|
4336
|
+
readonly content: string;
|
|
4337
|
+
}
|
|
4338
|
+
|
|
4307
4339
|
/**
|
|
4308
4340
|
* Email message definition.
|
|
4309
4341
|
* Compatible with nodemailer Mail.Options.
|
|
4342
|
+
* Other nodemailer message options are ignored by the Medplum server.
|
|
4310
4343
|
*/
|
|
4311
4344
|
export declare interface MailOptions {
|
|
4312
|
-
/** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com
|
|
4345
|
+
/** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>`. Must be an approved sender, otherwise the default sender address is used. */
|
|
4313
4346
|
readonly from?: string | MailAddress;
|
|
4314
|
-
/**
|
|
4347
|
+
/** Ignored by the Medplum server. The Sender: field is set to the from address. */
|
|
4315
4348
|
readonly sender?: string | MailAddress;
|
|
4316
4349
|
/** Comma separated list or an array of recipients e-mail addresses that will appear on the To: field */
|
|
4317
4350
|
readonly to?: MailDestination;
|
|
@@ -4329,6 +4362,8 @@ export declare interface MailOptions {
|
|
|
4329
4362
|
readonly html?: string;
|
|
4330
4363
|
/** An array of attachment objects */
|
|
4331
4364
|
readonly attachments?: MailAttachment[];
|
|
4365
|
+
/** iCalendar event to use as an alternative, for example an appointment invitation */
|
|
4366
|
+
readonly icalEvent?: string | MailIcalEvent;
|
|
4332
4367
|
}
|
|
4333
4368
|
|
|
4334
4369
|
/**
|
|
@@ -5862,6 +5897,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
|
|
|
5862
5897
|
* });
|
|
5863
5898
|
* ```
|
|
5864
5899
|
*
|
|
5900
|
+
* Only the options in {@link MailOptions} are supported; other nodemailer options are ignored.
|
|
5865
5901
|
* See the {@link https://nodemailer.com/extras/mailcomposer/ | nodemailer MailComposer options} for full details.
|
|
5866
5902
|
* @category Media
|
|
5867
5903
|
* @param email - The MailComposer options.
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1633,6 +1633,18 @@ export { ErrorEvent_2 as ErrorEvent }
|
|
|
1633
1633
|
*/
|
|
1634
1634
|
export declare function escapeHtml(unsafe: string): string;
|
|
1635
1635
|
|
|
1636
|
+
/**
|
|
1637
|
+
* Escapes a literal string for use as a single FHIR search value.
|
|
1638
|
+
* Backslash-escapes commas and backslashes, so that the value is not split into multiple "or" values.
|
|
1639
|
+
* This is the inverse of `splitSearchOnComma`.
|
|
1640
|
+
*
|
|
1641
|
+
* See: https://hl7.org/fhir/r4/search.html#escaping
|
|
1642
|
+
*
|
|
1643
|
+
* @param input - The literal string to search for.
|
|
1644
|
+
* @returns The escaped FHIR search value.
|
|
1645
|
+
*/
|
|
1646
|
+
export declare function escapeSearchValue(input: string): string;
|
|
1647
|
+
|
|
1636
1648
|
/**
|
|
1637
1649
|
* Escape token part of a JSON Pointer string
|
|
1638
1650
|
*
|
|
@@ -4287,16 +4299,23 @@ export declare interface MailAddress {
|
|
|
4287
4299
|
/**
|
|
4288
4300
|
* Email attachment definition.
|
|
4289
4301
|
* Compatible with nodemailer Mail.Options.
|
|
4302
|
+
* Other nodemailer attachment options are ignored by the Medplum server.
|
|
4290
4303
|
*/
|
|
4291
4304
|
export declare interface MailAttachment {
|
|
4292
|
-
/** String
|
|
4305
|
+
/** String contents for the attachment */
|
|
4293
4306
|
readonly content?: string;
|
|
4294
|
-
/**
|
|
4307
|
+
/** A `Binary/{id}` reference, an HTTPS URL, or a data URI, if you want to stream the file instead of including it (better for larger attachments). Local file paths are not allowed. */
|
|
4295
4308
|
readonly path?: string;
|
|
4296
4309
|
/** filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value as false, otherwise a filename is generated automatically */
|
|
4297
4310
|
readonly filename?: string | false;
|
|
4298
4311
|
/** optional content type for the attachment, if not set will be derived from the filename property */
|
|
4299
4312
|
readonly contentType?: string;
|
|
4313
|
+
/** optional content disposition type for the attachment, defaults to 'attachment' */
|
|
4314
|
+
readonly contentDisposition?: string;
|
|
4315
|
+
/** optional content id for using inline images in HTML message source */
|
|
4316
|
+
readonly cid?: string;
|
|
4317
|
+
/** If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: 'base64', 'hex', 'binary' etc. */
|
|
4318
|
+
readonly encoding?: string;
|
|
4300
4319
|
}
|
|
4301
4320
|
|
|
4302
4321
|
/**
|
|
@@ -4304,14 +4323,28 @@ export declare interface MailAttachment {
|
|
|
4304
4323
|
*/
|
|
4305
4324
|
export declare type MailDestination = string | MailAddress | string[] | MailAddress[];
|
|
4306
4325
|
|
|
4326
|
+
/**
|
|
4327
|
+
* Email calendar event definition.
|
|
4328
|
+
* Compatible with nodemailer Mail.IcalAttachment.
|
|
4329
|
+
*/
|
|
4330
|
+
export declare interface MailIcalEvent {
|
|
4331
|
+
/** Method of the calendar event, for example 'REQUEST' or 'CANCEL' */
|
|
4332
|
+
readonly method?: string;
|
|
4333
|
+
/** Filename of the calendar event attachment */
|
|
4334
|
+
readonly filename?: string;
|
|
4335
|
+
/** iCalendar contents of the event */
|
|
4336
|
+
readonly content: string;
|
|
4337
|
+
}
|
|
4338
|
+
|
|
4307
4339
|
/**
|
|
4308
4340
|
* Email message definition.
|
|
4309
4341
|
* Compatible with nodemailer Mail.Options.
|
|
4342
|
+
* Other nodemailer message options are ignored by the Medplum server.
|
|
4310
4343
|
*/
|
|
4311
4344
|
export declare interface MailOptions {
|
|
4312
|
-
/** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com
|
|
4345
|
+
/** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>`. Must be an approved sender, otherwise the default sender address is used. */
|
|
4313
4346
|
readonly from?: string | MailAddress;
|
|
4314
|
-
/**
|
|
4347
|
+
/** Ignored by the Medplum server. The Sender: field is set to the from address. */
|
|
4315
4348
|
readonly sender?: string | MailAddress;
|
|
4316
4349
|
/** Comma separated list or an array of recipients e-mail addresses that will appear on the To: field */
|
|
4317
4350
|
readonly to?: MailDestination;
|
|
@@ -4329,6 +4362,8 @@ export declare interface MailOptions {
|
|
|
4329
4362
|
readonly html?: string;
|
|
4330
4363
|
/** An array of attachment objects */
|
|
4331
4364
|
readonly attachments?: MailAttachment[];
|
|
4365
|
+
/** iCalendar event to use as an alternative, for example an appointment invitation */
|
|
4366
|
+
readonly icalEvent?: string | MailIcalEvent;
|
|
4332
4367
|
}
|
|
4333
4368
|
|
|
4334
4369
|
/**
|
|
@@ -5862,6 +5897,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
|
|
|
5862
5897
|
* });
|
|
5863
5898
|
* ```
|
|
5864
5899
|
*
|
|
5900
|
+
* Only the options in {@link MailOptions} are supported; other nodemailer options are ignored.
|
|
5865
5901
|
* See the {@link https://nodemailer.com/extras/mailcomposer/ | nodemailer MailComposer options} for full details.
|
|
5866
5902
|
* @category Media
|
|
5867
5903
|
* @param email - The MailComposer options.
|