@gatekeeper_technology/report-utils
Version:
Gatekeeper's pdf/email Utils - shared in NPM
35 lines • 1.66 kB
TypeScript
export { getToEmailsArray, setCheckWhitelistEnvironments, storeValidEmail, validateEmail, generateHTML, postToJourneyBackend };
/**
* Takes to and cc array of email addresses and ensures uniqueness and that they are part of the whitelist in testing and staging
* @param {string[]} to_array Array of email address
* @param {string[]} cc_array Array of email address
* @param {string} env Environment
* @param {string[]} whitelist Whitelisted email addresses
* @returns {{to: {email: string}[], cc: {email: string}[]}}
*/
declare function getToEmailsArray(to_array: string[], cc_array: string[], env: 'production' | 'testing' | 'staging', whitelist: string[]): {
to: {
email: string;
}[];
cc: {
email: string;
}[];
};
/**
* Sets the environments where email whitelisting should be enabled
*
* @param {string[]} environments array of environments to check whitelist
*/
declare function setCheckWhitelistEnvironments(environments: ('production' | 'testing' | 'staging')[]): void;
declare function storeValidEmail(email_object: Record<string, any>, email: string): void;
declare function validateEmail(email: string): boolean;
/**
*
* @param data The data generated by `generateData` function
* @param dirName Simply the built in variable `__dirname`
* @param fileName The name of the file.
* @returns HTML string.
*/
declare function generateHTML(data: Record<string, any>, dirName: string, fileName: string): string;
declare function postToJourneyBackend(object: Record<string, any>, fieldName: string, pdfHtml: string, fileName: string, token: string): Promise<boolean>;
//# sourceMappingURL=email_utils.d.ts.map