idea-aws 4.3.5 → 4.4.1

package/dist/src/s3.d.ts

@@ -1,225 +0,0 @@
-import * as AWSS3 from '@aws-sdk/client-s3';
-import { BodyDataTypes } from '@aws-sdk/lib-storage';
-import { SignedURL } from 'idea-toolbox';
-import { LambdaLogger } from './lambdaLogger';
-/**
- * A wrapper for AWS Simple Storage Service.
- */
-export declare class S3 {
-    protected s3: AWSS3.S3Client;
-    protected logger: LambdaLogger;
-    protected DEFAULT_DOWNLOAD_BUCKET_PREFIX: string;
-    protected DEFAULT_DOWNLOAD_BUCKET: string;
-    protected DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP: number;
-    protected DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP: number;
-    constructor();
-    /**
-     * Create a download link of a piece of data (through S3).
-     * *Practically*, it uploads the file on an S3 bucket, generating and returning a url to it.
-     */
-    createDownloadURLFromData(data: BodyDataTypes, options?: CreateDownloadURLFromDataOptions): Promise<SignedURL>;
-    /**
-     * Get a signed URL to put a file on a S3 bucket.
-     */
-    signedURLPut(bucket: string, key: string, options?: SignedURLOptions): Promise<SignedURL>;
-    /**
-     * Get a signed URL to get a file on a S3 bucket.
-     */
-    signedURLGet(bucket: string, key: string, options?: SignedURLOptions): Promise<SignedURL>;
-    /**
-     * Make a copy of an object of the bucket.
-     */
-    copyObject(options: CopyObjectOptions): Promise<void>;
-    /**
-     * Get an object from a S3 bucket.
-     */
-    getObject(options: GetObjectOptions): Promise<AWSS3.GetObjectCommandOutput>;
-    /**
-     * Get an object from a S3 bucket and parse the content as a JSON object.
-     */
-    getObjectAsJSON(options: GetObjectOptions): Promise<any>;
-    /**
-     * Get an object from a S3 bucket and convert the content to string.
-     */
-    getObjectAsText(options: GetObjectOptions): Promise<string>;
-    /**
-     * Put an object in a S3 bucket.
-     */
-    putObject(options: PutObjectOptions): Promise<AWSS3.PutObjectOutput>;
-    /**
-     * Delete an object from an S3 bucket.
-     */
-    deleteObject(options: DeleteObjectOptions): Promise<AWSS3.PutObjectOutput>;
-    /**
-     * List the objects of an S3 bucket.
-     */
-    listObjects(options: ListObjectsOptions): Promise<AWSS3.ListObjectsOutput>;
-    /**
-     * List the objects keys of an S3 bucket.
-     */
-    listObjectsKeys(options: ListObjectsOptions): Promise<string[]>;
-    /**
-     * Check whether an object exists in an S3 bucket.
-     */
-    doesObjectExist(options: HeadObjectOptions): Promise<boolean>;
-}
-/**
- * Options for creating a download URL.
- */
-export interface CreateDownloadURLFromDataOptions {
-    /**
-     * Downloads bucket; default: `idea-downloads`.
-     */
-    bucket?: string;
-    /**
-     * Folder (e.g. the project name); default: `common`.
-     */
-    prefix?: string;
-    /**
-     * The unique filepath in which to store the file; default: _random_.
-     */
-    key?: string;
-    /**
-     * Content type, e.g. application/json; default: _guessed_.
-     */
-    contentType?: string;
-    /**
-     * Seconds to URL expiration; default: `180`.
-     */
-    secToExp?: number;
-    /**
-     * The suggested name for the file once it's downloaded/saved.
-     * Note: the string is cleaned to ensure maximum compatibility with every OS.
-     */
-    filename?: string;
-}
-/**
- * Options for generating a signed URL.
- */
-export interface SignedURLOptions {
-    /**
-     * Seconds to URL expiration; default: `180` for GET, `300` for PUT.
-     */
-    secToExp?: number;
-    /**
-     * The suggested name for the file once it's downloaded/saved.
-     * Note: the string is cleaned to ensure maximum compatibility with every OS.
-     */
-    filename?: string;
-}
-/**
- * Options for copying an object.
- */
-export interface CopyObjectOptions {
-    /**
-     * The source path (complete with the bucket name).
-     */
-    copySource: string;
-    /**
-     * The bucket in which to copy the file.
-     */
-    bucket: string;
-    /**
-     * The complete filepath of the bucket in which to copy the file.
-     */
-    key: string;
-}
-/**
- * Options for getting an object.
- */
-export interface GetObjectOptions {
-    /**
-     * The bucket from which to acquire the file.
-     */
-    bucket: string;
-    /**
-     * The complete filepath (within the bucket) from which to acquire the file.
-     */
-    key: string;
-    /**
-     * The suggested name for the file once it's downloaded/saved.
-     * Note: the string is cleaned to ensure maximum compatibility with every OS.
-     */
-    filename?: string;
-}
-/**
- * Options for getting the head (main metadata, without the content) of an object.
- */
-export interface HeadObjectOptions {
-    /**
-     * The bucket from which to acquire the file.
-     */
-    bucket: string;
-    /**
-     * The complete filepath (within the bucket) from which to acquire the file.
-     */
-    key: string;
-    /**
-     * If set, the request will fail in case the object is empty (`ContentLength === 0`).
-     */
-    emptyMeansNotFound?: boolean;
-}
-/**
- * Options for putting an object.
- */
-export interface PutObjectOptions {
-    /**
-     * The bucket in which to copy the file.
-     */
-    bucket: string;
-    /**
-     * The complete filepath of the bucket in which to copy the file.
-     */
-    key: string;
-    /**
-     * The content of the file.
-     */
-    body: any;
-    /**
-     * Content type (e.g. image/png).
-     */
-    contentType?: string;
-    /**
-     * Access-control list (e.g. public-read).
-     */
-    acl?: string;
-    /**
-     * A set of metadata as attributes
-     */
-    metadata?: any;
-    /**
-     * The suggested name for the file once it's downloaded/saved.
-     * Note: the string is cleaned to ensure maximum compatibility with every OS.
-     */
-    filename?: string;
-}
-/**
- * Options for deleting an object.
- */
-export interface DeleteObjectOptions {
-    /**
-     * The bucket from which to delete the file.
-     */
-    bucket: string;
-    /**
-     * The complete filepath to the file to delete.
-     */
-    key: string;
-}
-/**
- * Options for listing a bucket's objects.
- */
-export interface ListObjectsOptions {
-    /**
-     * The bucket from which to list the objects.
-     */
-    bucket: string;
-    /**
-     * The prefix to filter the objects to select, based on the key.
-     */
-    prefix?: string;
-}
-/**
- * Clean a filename to be compatible with most OS.
- */
-export declare const cleanFilename: (filename: string) => string;

package/dist/src/s3.js

@@ -1,180 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanFilename = exports.S3 = void 0;
-const AWSS3 = __importStar(require("@aws-sdk/client-s3"));
-const lib_storage_1 = require("@aws-sdk/lib-storage");
-const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
-const idea_toolbox_1 = require("idea-toolbox");
-const lambdaLogger_1 = require("./lambdaLogger");
-/**
- * A wrapper for AWS Simple Storage Service.
- */
-class S3 {
-    constructor() {
-        this.logger = new lambdaLogger_1.LambdaLogger();
-        this.DEFAULT_DOWNLOAD_BUCKET_PREFIX = 'common';
-        this.DEFAULT_DOWNLOAD_BUCKET = 'idea-downloads';
-        this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP = 180;
-        this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP = 300;
-        this.s3 = new AWSS3.S3Client();
-    }
-    /**
-     * Create a download link of a piece of data (through S3).
-     * *Practically*, it uploads the file on an S3 bucket, generating and returning a url to it.
-     */
-    async createDownloadURLFromData(data, options = {}) {
-        // if needed, randomly generates the key
-        if (!options.key)
-            options.key = Date.now().toString().concat(Math.random().toString(36).slice(2));
-        options.key = `${options.prefix ?? this.DEFAULT_DOWNLOAD_BUCKET_PREFIX}/${options.key}`;
-        options.bucket = options.bucket ?? this.DEFAULT_DOWNLOAD_BUCKET;
-        options.secToExp = options.secToExp ?? this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP;
-        const params = { Bucket: options.bucket, Key: options.key, Body: data, ContentType: options.contentType };
-        const upload = new lib_storage_1.Upload({ client: this.s3, params });
-        await upload.done();
-        return this.signedURLGet(options.bucket, options.key, { secToExp: options.secToExp, filename: options.filename });
-    }
-    /**
-     * Get a signed URL to put a file on a S3 bucket.
-     */
-    async signedURLPut(bucket, key, options = {}) {
-        const putParams = { Bucket: bucket, Key: key };
-        if (options.filename)
-            putParams.ContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
-        const expiresIn = options.secToExp ?? this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP;
-        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new AWSS3.PutObjectCommand(putParams), { expiresIn });
-        return new idea_toolbox_1.SignedURL({ url });
-    }
-    /**
-     * Get a signed URL to get a file on a S3 bucket.
-     */
-    async signedURLGet(bucket, key, options = {}) {
-        const getParams = { Bucket: bucket, Key: key };
-        if (options.filename)
-            getParams.ResponseContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
-        const expiresIn = options.secToExp ?? this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP;
-        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new AWSS3.GetObjectCommand(getParams), { expiresIn });
-        return new idea_toolbox_1.SignedURL({ url });
-    }
-    /**
-     * Make a copy of an object of the bucket.
-     */
-    async copyObject(options) {
-        this.logger.trace(`S3 copy object: ${options.key}`);
-        const command = new AWSS3.CopyObjectCommand({
-            CopySource: options.copySource,
-            Bucket: options.bucket,
-            Key: options.key
-        });
-        await this.s3.send(command);
-    }
-    /**
-     * Get an object from a S3 bucket.
-     */
-    async getObject(options) {
-        this.logger.trace(`S3 get object: ${options.key}`);
-        const params = { Bucket: options.bucket, Key: options.key };
-        if (options.filename)
-            params.ResponseContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
-        const command = new AWSS3.GetObjectCommand(params);
-        return await this.s3.send(command);
-    }
-    /**
-     * Get an object from a S3 bucket and parse the content as a JSON object.
-     */
-    async getObjectAsJSON(options) {
-        const result = await this.getObject(options);
-        return JSON.parse(await result.Body.transformToString('utf-8'));
-    }
-    /**
-     * Get an object from a S3 bucket and convert the content to string.
-     */
-    async getObjectAsText(options) {
-        const result = await this.getObject(options);
-        return await result.Body.transformToString('utf-8');
-    }
-    /**
-     * Put an object in a S3 bucket.
-     */
-    async putObject(options) {
-        const params = { Bucket: options.bucket, Key: options.key, Body: options.body };
-        if (options.contentType)
-            params.ContentType = options.contentType;
-        if (options.acl)
-            params.ACL = options.acl;
-        if (options.metadata)
-            params.Metadata = options.metadata;
-        if (options.filename)
-            params.ContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
-        this.logger.trace(`S3 put object: ${options.key}`);
-        return await this.s3.send(new AWSS3.PutObjectCommand(params));
-    }
-    /**
-     * Delete an object from an S3 bucket.
-     */
-    async deleteObject(options) {
-        this.logger.trace(`S3 delete object: ${options.key}`);
-        const deleteCommand = new AWSS3.DeleteObjectCommand({ Bucket: options.bucket, Key: options.key });
-        return await this.s3.send(deleteCommand);
-    }
-    /**
-     * List the objects of an S3 bucket.
-     */
-    async listObjects(options) {
-        this.logger.trace(`S3 list object: ${options.prefix}`);
-        const command = new AWSS3.ListObjectsCommand({ Bucket: options.bucket, Prefix: options.prefix });
-        return await this.s3.send(command);
-    }
-    /**
-     * List the objects keys of an S3 bucket.
-     */
-    async listObjectsKeys(options) {
-        const result = await this.listObjects(options);
-        return result.Contents.map(obj => obj.Key);
-    }
-    /**
-     * Check whether an object exists in an S3 bucket.
-     */
-    async doesObjectExist(options) {
-        try {
-            const command = new AWSS3.HeadObjectCommand({ Bucket: options.bucket, Key: options.key });
-            const { ContentLength } = await this.s3.send(command);
-            if (options.emptyMeansNotFound)
-                return ContentLength > 0;
-            else
-                return true;
-        }
-        catch (err) {
-            return false;
-        }
-    }
-}
-exports.S3 = S3;
-/**
- * Clean a filename to be compatible with most OS.
- */
-const cleanFilename = (filename) => filename.replace(/[^a-z0-9-.\s]/gi, '_');
-exports.cleanFilename = cleanFilename;

package/dist/src/secretsManager.d.ts

@@ -1,15 +0,0 @@
-import * as AWSSecretsManager from '@aws-sdk/client-secrets-manager';
-/**
- * A wrapper for AWS Secrets manager.
- */
-export declare class SecretsManager {
-    protected sm: AWSSecretsManager.SecretsManagerClient;
-    protected cache: Map<string, string>;
-    constructor();
-    /**
-     * Get a secret string from the Secret Manager by its id.
-     */
-    getStringById(secretId: string, options?: {
-        noCache?: boolean;
-    }): Promise<string>;
-}

package/dist/src/secretsManager.js

@@ -1,48 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecretsManager = void 0;
-const AWSSecretsManager = __importStar(require("@aws-sdk/client-secrets-manager"));
-/**
- * A wrapper for AWS Secrets manager.
- */
-class SecretsManager {
-    constructor() {
-        this.cache = new Map();
-        this.sm = new AWSSecretsManager.SecretsManagerClient();
-    }
-    /**
-     * Get a secret string from the Secret Manager by its id.
-     */
-    async getStringById(secretId, options = {}) {
-        if (!options.noCache && this.cache.has(secretId))
-            return this.cache.get(secretId);
-        const command = new AWSSecretsManager.GetSecretValueCommand({ SecretId: secretId });
-        const { SecretString } = await this.sm.send(command);
-        this.cache.set(secretId, SecretString);
-        return SecretString;
-    }
-}
-exports.SecretsManager = SecretsManager;

package/dist/src/ses.d.ts

@@ -1,161 +0,0 @@
-/// <reference types="node" />
-import * as AWSSES from '@aws-sdk/client-sesv2';
-import { SentMessageInfo as NodemailerSentMessageInfo } from 'nodemailer';
-import { Headers } from 'nodemailer/lib/mailer';
-import { LambdaLogger } from './lambdaLogger';
-/**
- * A wrapper for AWS Simple Email Service.
- */
-export declare class SES {
-    protected ses: AWSSES.SESv2Client;
-    protected logger: LambdaLogger;
-    constructor(options?: {
-        region?: string;
-    });
-    getTemplate(templateName: string): Promise<AWSSES.EmailTemplateContent>;
-    setTemplate(templateName: string, subject: string, content: string, isHTML?: boolean): Promise<void>;
-    deleteTemplate(templateName: string): Promise<void>;
-    testTemplate(templateName: string, data: {
-        [variable: string]: any;
-    }): Promise<string>;
-    /**
-     * Send a templated email through AWS Simple Email Service.
-     */
-    sendTemplatedEmail(emailData: TemplatedEmailData, sesParams: SESParams): Promise<AWSSES.SendEmailCommandOutput>;
-    /**
-     * Send an email through AWS Simple Email Service.
-     * It supports IDEA's teams custom configuration.
-     */
-    sendEmail(emailData: EmailData, sesParams: SESParams): Promise<AWSSES.SendEmailResponse | NodemailerSentMessageInfo>;
-    private searchForCustomSESConfigByTeamId;
-    private sendEmailWithSES;
-    private sendEmailWithNodemailer;
-    private prepareEmailDestination;
-    private prepareEmailMessage;
-}
-/**
- * The basic data to send an email.
- */
-export interface BasicEmailData {
-    /**
-     * Array of TO email addresses.
-     */
-    toAddresses: string[];
-    /**
-     * Array of CC email addresses.
-     */
-    ccAddresses?: string[];
-    /**
-     * Array of BCC email addresses.
-     */
-    bccAddresses?: string[];
-    /**
-     * Array of Reply-To email addresses.
-     */
-    replyToAddresses?: string[];
-}
-/**
- * The data to send an email.
- */
-export interface EmailData extends BasicEmailData {
-    /**
-     * Subject of the email.
-     */
-    subject: string;
-    /**
-     * HTML content of the email.
-     */
-    html?: string;
-    /**
-     * Text content of the email
-     */
-    text?: string;
-    /**
-     * The array of attachments. Ref. https://community.nodemailer.com/using-attachments/
-     */
-    attachments?: EmailAttachment[];
-}
-/**
- * Email attachment interface of Nodemailer.
- */
-export interface EmailAttachment {
-    /**
-     * String, Buffer or a Stream contents for the attachmentent
-     */
-    content?: string | Buffer;
-    /**
-     * Path to a file or an URL (data uris are allowed as well) if you want to stream the file instead of including it
-     * (better for larger attachments).
-     */
-    path?: string;
-    /**
-     * 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 .
-     */
-    filename?: string | false;
-    /**
-     * If set and content is string, then encodes the content to a Buffer using the specified encoding.
-     * Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail.
-     */
-    encoding?: string;
-    /**
-     * Optional content type for the attachment, if not set will be derived from the filename property
-     */
-    contentType?: string;
-    /**
-     * Additional headers
-     */
-    headers?: Headers;
-    /**
-     * Optional value that overrides entire node content in the mime message.
-     * If used then all other options set for this node are ignored.
-     */
-    raw?: string | Buffer;
-}
-/**
- * The data to send a templated email.
- * Note: templated email don't support attachments by now.
- */
-export interface TemplatedEmailData extends BasicEmailData {
-    /**
-     * The template to use for sending the email.
-     * To reference variables, use placeholders such as `{{myVar}}`.
-     */
-    template: string;
-    /**
-     * An object containing key-value pairs of variable-content to substitute.
-     * It supports handlebars.js templating.
-     */
-    templateData: {
-        [variable: string]: any;
-    };
-    /**
-     * The name of the configuration set to use for the sending.
-     */
-    configurationSet?: string;
-}
-/**
- * SES configuration.
- */
-export interface SESParams {
-    /**
-     * The source (from) email address.
-     */
-    source: string;
-    /**
-     * The optional name of the source (e.g. Matteo Carbone).
-     */
-    sourceName?: string;
-    /**
-     * The SES source ARN to use, in case the source doesn't directly match a SES validated email address.
-     */
-    sourceArn?: string;
-    /**
-     * The SES region to use, in case it differs from the one of the Lambda function running the command.
-     */
-    region?: string;
-    /**
-     * If set, a custom SES configuration to use for the team will be searched in the table `idea_teamsSES`.
-     */
-    teamId?: string;
-}