@bitblit/ratchet-aws 4.0.80-alpha

package/dist/types/expiring-code/s3-expiring-code-provider.d.ts

@@ -0,0 +1,17 @@
+import { ExpiringCodeProvider } from './expiring-code-provider';
+import { ExpiringCode } from './expiring-code';
+import { S3CacheRatchet } from '../s3/s3-cache-ratchet';
+import { PutObjectOutput } from '@aws-sdk/client-s3';
+export declare class S3ExpiringCodeProvider implements ExpiringCodeProvider {
+    private s3CacheRatchet;
+    private keyName;
+    constructor(s3CacheRatchet: S3CacheRatchet, keyName: string);
+    fetchFile(): Promise<S3ExpiringCodeProviderFileWrapper>;
+    updateFile(vals: ExpiringCode[]): Promise<PutObjectOutput>;
+    checkCode(code: string, context: string, deleteOnMatch?: boolean): Promise<boolean>;
+    storeCode(code: ExpiringCode): Promise<boolean>;
+}
+export interface S3ExpiringCodeProviderFileWrapper {
+    data: ExpiringCode[];
+    lastModifiedEpochMS: number;
+}

package/dist/types/iam/aws-credentials-ratchet.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Ratchet for manipulating credentials
+ *
+ * Mainly here so I don't have to remember certain specific AWS environmental variable names
+ */
+export declare class AwsCredentialsRatchet {
+    private constructor();
+    static applySetProfileEnvironmentalVariable(newProfile: string): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from './batch/aws-batch-background-processor';
+export * from './batch/aws-batch-ratchet';
+export * from './build/ratchet-aws-info';
+export * from './cache/dynamo-db-storage-provider';
+export * from './cache/s3-storage-provider';
+export * from './cache/simple-cache-object-wrapper';
+export * from './cache/simple-cache-read-options';
+export * from './cache/simple-cache-storage-provider';
+export * from './cache/simple-cache';
+export * from './cloudwatch/cloud-watch-log-group-ratchet';
+export * from './cloudwatch/cloud-watch-logs-ratchet';
+export * from './cloudwatch/cloud-watch-metrics-ratchet';
+export * from './daemon/daemon-like';
+export * from './daemon/daemon-process-create-options';
+export * from './daemon/daemon-process-state-public-token';
+export * from './daemon/daemon-process-state';
+export * from './daemon/daemon-util';
+export * from './daemon/daemon';
+export * from './dao/prototype-dao-config';
+export * from './dao/prototype-dao-db';
+export * from './dao/prototype-dao-provider';
+export * from './dao/prototype-dao';
+export * from './dao/s3-prototype-dao-provider';
+export * from './dao/s3-simple-dao';
+export * from './dao/simple-dao-item';
+export * from './dynamodb/dynamo-ratchet-like';
+export * from './dynamodb/dynamo-ratchet';
+export * from './dynamodb/dynamo-table-ratchet';
+export * from './dynamodb/hash-spreader';
+export * from './ec2/ec2-ratchet';
+export * from './environment/cascade-environment-service-provider';
+export * from './environment/env-var-environment-service-provider';
+export * from './environment/environment-service-config';
+export * from './environment/environment-service-provider';
+export * from './environment/environment-service';
+export * from './environment/fixed-environment-service-provider';
+export * from './environment/s3-environment-service-provider';
+export * from './environment/ssm-environment-service-provider';
+export * from './expiring-code/dynamo-expiring-code-provider';
+export * from './expiring-code/expiring-code-params';
+export * from './expiring-code/expiring-code-provider';
+export * from './expiring-code/expiring-code-ratchet';
+export * from './expiring-code/expiring-code';
+export * from './expiring-code/s3-expiring-code-provider';
+export * from './iam/aws-credentials-ratchet';
+export * from './lambda/lambda-event-detector';
+export * from './lambda/lambda-event-type-guards';
+export * from './model/cloud-watch-metrics-minute-level-dynamo-count-request';
+export * from './model/cloud-watch-metrics-unit';
+export * from './model/dynamo-count-result';
+export * from './model/dynamo/doc-put-item-command-input';
+export * from './model/dynamo/doc-query-command-input';
+export * from './model/dynamo/doc-scan-command-input';
+export * from './model/dynamo/doc-update-item-command-input';
+export * from './route53/route-53-ratchet';
+export * from './runtime-parameter/cached-stored-runtime-parameter';
+export * from './runtime-parameter/dynamo-runtime-parameter-provider';
+export * from './runtime-parameter/global-variable-override-runtime-parameter-provider';
+export * from './runtime-parameter/memory-runtime-parameter-provider';
+export * from './runtime-parameter/runtime-parameter-provider';
+export * from './runtime-parameter/runtime-parameter-ratchet';
+export * from './runtime-parameter/stored-runtime-parameter';
+export * from './s3/s3-cache-ratchet';
+export * from './s3/s3-cache-to-local-disk-ratchet';
+export * from './s3/s3-location-sync-ratchet';
+export * from './s3/s3-ratchet';
+export * from './ses/email-attachment';
+export * from './ses/mailer-config';
+export * from './ses/mailer-like';
+export * from './ses/mailer';
+export * from './ses/ratchet-template-renderer';
+export * from './ses/ready-to-send-email';
+export * from './ses/remote-handlebars-template-renderer';
+export * from './ses/resolved-ready-to-send-email';
+export * from './sns/sns-ratchet';
+export * from './sync-lock/dynamo-db-sync-lock';
+export * from './sync-lock/memory-sync-lock';
+export * from './sync-lock/sync-lock-provider';

package/dist/types/lambda/lambda-event-detector.d.ts

@@ -0,0 +1,14 @@
+export declare class LambdaEventDetector {
+    static isValidCronEvent(event: any): boolean;
+    static isValidSnsEvent(event: any): boolean;
+    static isValidDynamoDBEvent(event: any): boolean;
+    static isValidS3Event(event: any): boolean;
+    static isValidApiGatewayV2WithRequestContextEvent(event: any): boolean;
+    static isValidApiGatewayEvent(event: any): boolean;
+    static isValidApiGatewayAuthorizerEvent(event: any): boolean;
+    static isSingleCronEvent(event: any): boolean;
+    static isSingleSnsEvent(event: any): boolean;
+    static isSingleDynamoDBEvent(event: any): boolean;
+    static isSingleS3Event(event: any): boolean;
+    static isSingleEntryEvent(event: any, entryName?: string): boolean;
+}

package/dist/types/lambda/lambda-event-type-guards.d.ts

@@ -0,0 +1,10 @@
+import { APIGatewayEvent, APIGatewayProxyEventV2, DynamoDBStreamEvent, S3Event, ScheduledEvent, SNSEvent } from 'aws-lambda';
+export declare class LambdaEventTypeGuards {
+    static isValidCronEvent(event: any): event is ScheduledEvent;
+    static isValidSnsEvent(event: any): event is SNSEvent;
+    static isValidDynamoDBEvent(event: any): event is DynamoDBStreamEvent;
+    static isValidS3Event(event: any): event is S3Event;
+    static isValidApiGatewayV2WithRequestContextEvent(event: any): event is APIGatewayProxyEventV2;
+    static isValidApiGatewayEvent(event: any): event is APIGatewayEvent;
+    static isValidApiGatewayAuthorizerEvent(event: any): boolean;
+}

package/dist/types/model/cloud-watch-metrics-minute-level-dynamo-count-request.d.ts

@@ -0,0 +1,12 @@
+import { KeyValue } from '@bitblit/ratchet-common';
+import { DynamoRatchet } from '../dynamodb/dynamo-ratchet';
+import { QueryInput, ScanCommandInput } from '@aws-sdk/client-dynamodb';
+export interface CloudWatchMetricsMinuteLevelDynamoCountRequest {
+    dynamoRatchet: DynamoRatchet;
+    query: QueryInput;
+    scan: ScanCommandInput;
+    minuteUTC: string;
+    namespace: string;
+    metric: string;
+    dims: KeyValue[];
+}

package/dist/types/model/cloud-watch-metrics-unit.d.ts

@@ -0,0 +1,29 @@
+export declare enum CloudWatchMetricsUnit {
+    Seconds = "Seconds",
+    Microseconds = "Microseconds",
+    Milliseconds = "Milliseconds",
+    Bytes = "Bytes",
+    Kilobytes = "Kilobytes",
+    Megabytes = "Megabytes",
+    Gigabytes = "Gigabytes",
+    Terabytes = "Terabytes",
+    Bits = "Bits",
+    Kilobits = "Kilobits",
+    Megabits = "Megabits",
+    Gigabits = "Gigabits",
+    Terabits = "Terabits",
+    Percent = "Percent",
+    Count = "Count",
+    BytesPerSecond = "Bytes/Second",
+    KilobytesPerSecond = "Kilobytes/Second",
+    MegabytesPerSecond = "Megabytes/Second",
+    GigabytesPerSecond = "Gigabytes/Second",
+    TerabytesPerSecond = "Terabytes/Second",
+    BitsPerSecond = "Terabytes/Second",
+    KilobitsPerSecond = "Kilobits/Second",
+    MegabitsPerSecond = "Megabits/Second",
+    GigabitsPerSecond = "Gigabits/Second",
+    TerabitsPerSecond = "Terabits/Second",
+    CountPerSecond = "Count/Second",
+    None = "None"
+}

package/dist/types/model/dynamo/doc-put-item-command-input.d.ts

@@ -0,0 +1,4 @@
+import { PutItemCommandInput } from '@aws-sdk/client-dynamodb';
+export interface DocPutItemCommandInput extends PutItemCommandInput {
+    Item: Record<string, any>;
+}

package/dist/types/model/dynamo/doc-query-command-input.d.ts

@@ -0,0 +1,5 @@
+import { QueryCommandInput } from '@aws-sdk/client-dynamodb';
+export interface DocQueryCommandInput extends QueryCommandInput {
+    ExpressionAttributeValues?: Record<string, any>;
+    ExpressionAttributeNames?: Record<string, any>;
+}

package/dist/types/model/dynamo/doc-scan-command-input.d.ts

@@ -0,0 +1,5 @@
+import { ScanCommandInput } from '@aws-sdk/client-dynamodb';
+export interface DocScanCommandInput extends ScanCommandInput {
+    ExpressionAttributeValues?: Record<string, any>;
+    ExpressionAttributeNames?: Record<string, any>;
+}

package/dist/types/model/dynamo/doc-update-item-command-input.d.ts

@@ -0,0 +1,5 @@
+import { UpdateItemCommandInput } from '@aws-sdk/client-dynamodb';
+export interface DocUpdateItemCommandInput extends UpdateItemCommandInput {
+    ExpressionAttributeValues?: Record<string, any>;
+    ExpressionAttributeNames?: Record<string, any>;
+}

package/dist/types/model/dynamo-count-result.d.ts

@@ -0,0 +1,5 @@
+export interface DynamoCountResult {
+    count: number;
+    scannedCount: number;
+    pages: number;
+}

package/dist/types/route53/route-53-ratchet.d.ts

@@ -0,0 +1,7 @@
+import { Route53Client } from '@aws-sdk/client-route-53';
+export declare class Route53Ratchet {
+    private route53;
+    private hostedZoneId;
+    constructor(route53: Route53Client, hostedZoneId: string);
+    changeCnameRecordTarget(domainName: string, target: string, hostedZoneId?: string, ttlSeconds?: number): Promise<boolean>;
+}

package/dist/types/runtime-parameter/cached-stored-runtime-parameter.d.ts

@@ -0,0 +1,4 @@
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+export interface CachedStoredRuntimeParameter extends StoredRuntimeParameter {
+    storedEpochMS: number;
+}

package/dist/types/runtime-parameter/dynamo-runtime-parameter-provider.d.ts

@@ -0,0 +1,11 @@
+import { RuntimeParameterProvider } from './runtime-parameter-provider';
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+import { DynamoRatchet } from '../dynamodb/dynamo-ratchet';
+export declare class DynamoRuntimeParameterProvider implements RuntimeParameterProvider {
+    private dynamo;
+    private tableName;
+    constructor(dynamo: DynamoRatchet, tableName: string);
+    readParameter(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readAllParametersForGroup(groupId: string): Promise<StoredRuntimeParameter[]>;
+    writeParameter(toStore: StoredRuntimeParameter): Promise<boolean>;
+}

package/dist/types/runtime-parameter/global-variable-override-runtime-parameter-provider.d.ts

@@ -0,0 +1,24 @@
+import { RuntimeParameterProvider } from './runtime-parameter-provider';
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+/**
+ * Provides parameters for a runtime parameter from an global (ie, process.env or global.xx) variable, where the key follows
+ * a given format
+ *
+ * "Simple" because it forces all ttls to be the same value (ignores what is passed in) so that the
+ * envvar itself can be just a string instead of a complex value
+ */
+export declare class GlobalVariableOverrideRuntimeParameterProvider implements RuntimeParameterProvider {
+    private wrapped;
+    private options;
+    constructor(wrapped: RuntimeParameterProvider, opts?: GlobalVariableOverrideRuntimeParameterProviderOptions);
+    generateName(groupId: string, paramKey: string): string;
+    readParameter(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readAllParametersForGroup(groupId: string): Promise<StoredRuntimeParameter[]>;
+    writeParameter(toStore: StoredRuntimeParameter): Promise<boolean>;
+}
+export interface GlobalVariableOverrideRuntimeParameterProviderOptions {
+    globalTTL: number;
+    separator: string;
+    prefix?: string;
+    suffix?: string;
+}

package/dist/types/runtime-parameter/memory-runtime-parameter-provider.d.ts

@@ -0,0 +1,13 @@
+import { RuntimeParameterProvider } from './runtime-parameter-provider';
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+/**
+ * Very simple class, basically here just for unit testing although I suppose you could
+ * use it for something else
+ */
+export declare class MemoryRuntimeParameterProvider implements RuntimeParameterProvider {
+    private data;
+    constructor(data?: Promise<Record<string, StoredRuntimeParameter>>);
+    readParameter(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readAllParametersForGroup(groupId: string): Promise<StoredRuntimeParameter[]>;
+    writeParameter(toStore: StoredRuntimeParameter): Promise<boolean>;
+}

package/dist/types/runtime-parameter/runtime-parameter-provider.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Classes implementing RuntimeParameterProvider offer the ability to fetch a runtime parameter
+ * object from _somewhere_
+ * They do NOT handle local caching - the RuntimeParameterRatchet does that
+ */
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+export interface RuntimeParameterProvider {
+    readParameter(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readAllParametersForGroup(groupId: string): Promise<StoredRuntimeParameter[]>;
+    writeParameter(param: StoredRuntimeParameter): Promise<boolean>;
+}

package/dist/types/runtime-parameter/runtime-parameter-ratchet.d.ts

@@ -0,0 +1,15 @@
+import { RuntimeParameterProvider } from './runtime-parameter-provider';
+import { StoredRuntimeParameter } from './stored-runtime-parameter';
+export declare class RuntimeParameterRatchet {
+    private provider;
+    private cache;
+    constructor(provider: RuntimeParameterProvider);
+    fetchParameter<T>(groupId: string, paramKey: string, defaultValue?: T, forceFreshRead?: boolean): Promise<T>;
+    fetchAllParametersForGroup(groupId: string): Promise<Map<string, any>>;
+    readUnderlyingEntry(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readUnderlyingEntries(groupId: string): Promise<StoredRuntimeParameter[]>;
+    storeParameter(groupId: string, paramKey: string, paramValue: any, ttlSeconds: number): Promise<StoredRuntimeParameter>;
+    private static toCacheStoreKey;
+    private addToCache;
+    clearCache(): void;
+}

package/dist/types/runtime-parameter/stored-runtime-parameter.d.ts

@@ -0,0 +1,6 @@
+export interface StoredRuntimeParameter {
+    groupId: string;
+    paramKey: string;
+    paramValue: string;
+    ttlSeconds: number;
+}

package/dist/types/s3/s3-cache-ratchet.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { CompleteMultipartUploadCommandOutput, CopyObjectCommandOutput, DeleteObjectCommandOutput, GetObjectCommandOutput, HeadObjectCommandOutput, PutObjectCommandInput, S3Client } from '@aws-sdk/client-s3';
+import { Readable } from 'stream';
+export declare class S3CacheRatchet {
+    private s3;
+    private defaultBucket;
+    constructor(s3: S3Client, defaultBucket?: string);
+    static applyCacheControlMaxAge(input: PutObjectCommandInput, seconds: number): PutObjectCommandInput;
+    static applyUserMetaData(input: PutObjectCommandInput, key: string, value: string): PutObjectCommandInput;
+    getDefaultBucket(): string;
+    getS3Client(): S3Client;
+    fileExists(key: string, bucket?: string): Promise<boolean>;
+    fetchCacheFileAsS3GetObjectCommandOutput(key: string, bucket?: string): Promise<GetObjectCommandOutput>;
+    fetchCacheFileAsReadableStream(key: string, bucket?: string): Promise<ReadableStream>;
+    fetchCacheFileAsBuffer(key: string, bucket?: string): Promise<Buffer>;
+    fetchCacheFileAsString(key: string, bucket?: string): Promise<string>;
+    fetchCacheFileAsObject<T>(key: string, bucket?: string): Promise<T>;
+    removeCacheFile(key: string, bucket?: string): Promise<DeleteObjectCommandOutput>;
+    writeObjectToCacheFile(key: string, dataObject: any, // eslint-disable-line @typescript-eslint/explicit-module-boundary-types
+    template?: PutObjectCommandInput, bucket?: string): Promise<CompleteMultipartUploadCommandOutput>;
+    writeStringToCacheFile(key: string, dataString: string, template?: PutObjectCommandInput, bucket?: string): Promise<CompleteMultipartUploadCommandOutput>;
+    writeStreamToCacheFile(key: string, data: ReadableStream | Readable, template?: PutObjectCommandInput, bucket?: string): Promise<CompleteMultipartUploadCommandOutput>;
+    synchronize(srcPrefix: string, targetPrefix: string, targetRatchet?: S3CacheRatchet, recurseSubFolders?: boolean): Promise<string[]>;
+    fetchMetaForCacheFile(key: string, bucket?: string): Promise<HeadObjectCommandOutput>;
+    cacheFileAgeInSeconds(key: string, bucket?: string): Promise<number>;
+    copyFile(srcKey: string, dstKey: string, srcBucket?: string, dstBucket?: string): Promise<CopyObjectCommandOutput>;
+    quietCopyFile(srcKey: string, dstKey: string, srcBucket?: string, dstBucket?: string): Promise<boolean>;
+    preSignedDownloadUrlForCacheFile(key: string, expirationSeconds?: number, bucket?: string): Promise<string>;
+    directChildrenOfPrefix(prefix: string, expandFiles?: boolean, bucket?: string, maxToReturn?: number): Promise<string[]>;
+    allSubFoldersOfPrefix(prefix: string, bucket?: string): Promise<string[]>;
+    private bucketVal;
+}
+export interface ExpandedFileChildren {
+    link: string;
+    name: string;
+    size: number;
+}

package/dist/types/s3/s3-cache-to-local-disk-ratchet.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { S3CacheRatchet } from './s3-cache-ratchet';
+/**
+ * Use this when you want a lambda to cache a remote S3 bucket locally on disk for faster access
+ */
+export declare class S3CacheToLocalDiskRatchet {
+    private s3;
+    private tmpFolder;
+    private cacheTimeoutSeconds;
+    private static readonly DEFAULT_CACHE_TIMEOUT_SEC;
+    private currentlyLoading;
+    constructor(s3: S3CacheRatchet, tmpFolder: string, cacheTimeoutSeconds?: number);
+    getFileString(key: string): Promise<string>;
+    private keyToLocalCachePath;
+    removeCacheFileForKey(key: string): void;
+    getFileBuffer(key: string): Promise<Buffer>;
+    private updateLocalCacheFile;
+    getCacheFileAsString(filePath: string): string;
+    getCacheFileAsBuffer(filePath: string): Buffer;
+    private generateCacheHash;
+}

package/dist/types/s3/s3-location-sync-ratchet.d.ts

@@ -0,0 +1,21 @@
+import { S3Client } from '@aws-sdk/client-s3';
+export interface S3LocationSyncRatchetConfig {
+    srcS3: S3Client;
+    srcBucket: string;
+    srcPrefix: string;
+    dstS3: S3Client;
+    dstBucket: string;
+    dstPrefix: string;
+    maxNumThreads?: number;
+    maxRetries?: number;
+}
+export declare class S3LocationSyncRatchet {
+    private config;
+    constructor(config: S3LocationSyncRatchetConfig);
+    updateSrcPrefix(prefix: string): void;
+    updateDstPrefix(prefix: string): void;
+    copyObject(key: string, size: number, express?: boolean): Promise<void>;
+    listObjects(bucket: string, prefix: string, s3: S3Client): Promise<any>;
+    startSyncing(): Promise<boolean>;
+    private compareSrcAndDst;
+}

package/dist/types/s3/s3-ratchet.d.ts

@@ -0,0 +1,5 @@
+export declare class S3Ratchet {
+    static checkS3UrlForValidity(value: string): boolean;
+    static extractBucketFromURL(value: string): string;
+    static extractKeyFromURL(value: string): string;
+}

package/dist/types/ses/email-attachment.d.ts

@@ -0,0 +1,23 @@
+/**
+ * tbd
+ * @interface EmailAttachment
+ */
+export interface EmailAttachment {
+    /**
+     * @type {string}
+     * @memberof EmailAttachment
+     */
+    filename?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailAttachment
+     */
+    contentType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailAttachment
+     */
+    base64Data?: string;
+}

package/dist/types/ses/mailer-config.d.ts

@@ -0,0 +1,15 @@
+import { RatchetTemplateRenderer } from './ratchet-template-renderer';
+import { S3CacheRatchet } from '../s3/s3-cache-ratchet';
+/**
+ * Configuration options for generic mailer
+ */
+export interface MailerConfig {
+    defaultSendingAddress?: string;
+    autoBccAddresses?: string[];
+    templateRenderer?: RatchetTemplateRenderer;
+    allowedDestinationEmails?: RegExp[];
+    archive?: S3CacheRatchet;
+    archivePrefix?: string;
+    maxMessageBodySizeInBytes?: number;
+    maxAttachmentSizeInBase64Bytes?: number;
+}

package/dist/types/ses/mailer-like.d.ts

@@ -0,0 +1,18 @@
+import { ReadyToSendEmail } from './ready-to-send-email';
+import { SendRawEmailResponse } from '@aws-sdk/client-ses';
+import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email';
+/**
+ * Generic Mail Sender for AWS.
+ *
+ * Params:
+ * ses: AWS SES handler, properly configured
+ * defaultSendingAddress:
+ */
+export interface MailerLike {
+    fillEmailBody(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<ReadyToSendEmail>;
+    fillEmailBodyAndSend(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<SendRawEmailResponse>;
+    filterEmailsToValid(emails: string[]): string[];
+    applyLimitsToBodySizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
+    applyLimitsToAttachmentSizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
+    sendEmail(inRts: ReadyToSendEmail): Promise<SendRawEmailResponse>;
+}

package/dist/types/ses/mailer.d.ts

@@ -0,0 +1,26 @@
+import { ReadyToSendEmail } from './ready-to-send-email';
+import { SendRawEmailCommandOutput, SendRawEmailResponse, SESClient } from '@aws-sdk/client-ses';
+import { MailerConfig } from './mailer-config';
+import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email';
+import { MailerLike } from './mailer-like';
+/**
+ * Generic Mail Sender for AWS.
+ *
+ * Params:
+ * ses: AWS SES handler, properly configured
+ * defaultSendingAddress:
+ */
+export declare class Mailer implements MailerLike {
+    private ses;
+    private config;
+    static readonly EMAIL: RegExp;
+    constructor(ses: SESClient, config?: MailerConfig);
+    fillEmailBody(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<ReadyToSendEmail>;
+    fillEmailBodyAndSend(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<SendRawEmailResponse>;
+    filterEmailsToValid(emails: string[]): string[];
+    private archiveEmailIfConfigured;
+    applyLimitsToBodySizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
+    applyLimitsToAttachmentSizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
+    sendEmail(inRts: ReadyToSendEmail): Promise<SendRawEmailCommandOutput>;
+    static validEmail(email: string): boolean;
+}

package/dist/types/ses/ratchet-template-renderer.d.ts

@@ -0,0 +1,8 @@
+/**
+ * tbd
+ * @interface RatchetTemplateRenderer
+ */
+export interface RatchetTemplateRenderer {
+    renderTemplate(templateName: string, context: any, layoutName?: string, partialNames?: string[]): Promise<string>;
+    renderTemplateDirect(templateValue: string, context: any, layoutName?: string): Promise<string>;
+}

package/dist/types/ses/ready-to-send-email.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @interface ReadyToSendEmail
+ */
+import { EmailAttachment } from './email-attachment';
+export interface ReadyToSendEmail {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ReadyToSendEmail
+     */
+    destinationAddresses?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ReadyToSendEmail
+     */
+    bccAddresses?: Array<string>;
+    /**
+     *
+     * @type {Array<EmailAttachment>}
+     * @memberof ReadyToSendEmail
+     */
+    attachments?: Array<EmailAttachment>;
+    /**
+     *
+     * @type {string}
+     * @memberof ReadyToSendEmail
+     */
+    fromAddress?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReadyToSendEmail
+     */
+    txtMessage?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReadyToSendEmail
+     */
+    htmlMessage?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReadyToSendEmail
+     */
+    subject?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReadyToSendEmail
+     */
+    fromName?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReadyToSendEmail
+     */
+    doNotAutoBcc?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReadyToSendEmail
+     */
+    doNotArchive?: boolean;
+}

package/dist/types/ses/remote-handlebars-template-renderer.d.ts

@@ -0,0 +1,15 @@
+import { RatchetTemplateRenderer } from './ratchet-template-renderer';
+/**
+ */
+export declare class RemoteHandlebarsTemplateRenderer implements RatchetTemplateRenderer {
+    private prefix;
+    private suffix;
+    private maxCacheTemplates;
+    private cache;
+    constructor(prefix?: string, suffix?: string, maxCacheTemplates?: number);
+    renderTemplate(templateName: string, context: any, layoutName?: string): Promise<string>;
+    renderRemoteTemplate(templateName: string, inContext: any, layoutName?: string): Promise<string>;
+    renderTemplateDirect(templateText: string, context: any, layoutName?: string): Promise<string>;
+    private fetchTemplate;
+    private fetchTemplateText;
+}

package/dist/types/ses/resolved-ready-to-send-email.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @interface ResolvedReadyToSendEmail
+ */
+import { ReadyToSendEmail } from './ready-to-send-email';
+export interface ResolvedReadyToSendEmail extends ReadyToSendEmail {
+    /**
+     * The list of destination addresses before any sending/filtering rules were applied
+     * @type {Array<string>}
+     * @memberof ReadyToSendEmail
+     */
+    srcDestinationAddresses?: string[];
+    /**
+     * The original list of bcc addresses before any auto-bcc were added
+     */
+    srcBccAddresses?: string[];
+}

package/dist/types/sns/sns-ratchet.d.ts

@@ -0,0 +1,8 @@
+import { PublishCommandOutput, SNSClient } from '@aws-sdk/client-sns';
+export declare class SnsRatchet {
+    private sns;
+    private topicArn;
+    constructor(sns: SNSClient, topicArn: string);
+    sendMessage(inMsg: any, suppressErrors?: boolean): Promise<PublishCommandOutput>;
+    conditionallySendMessage(inMsg: any, condition: boolean, suppressErrors?: boolean): Promise<PublishCommandOutput>;
+}

package/dist/types/sync-lock/dynamo-db-sync-lock.d.ts

@@ -0,0 +1,10 @@
+import { DynamoRatchet } from '../dynamodb/dynamo-ratchet';
+import { SyncLockProvider } from './sync-lock-provider';
+export declare class DynamoDbSyncLock implements SyncLockProvider {
+    private ratchet;
+    private tableName;
+    constructor(ratchet: DynamoRatchet, tableName: string);
+    acquireLock(lockKey: string, expirationSeconds?: number): Promise<boolean>;
+    releaseLock(lockKey: string): Promise<void>;
+    clearExpiredSyncLocks(): Promise<number>;
+}

package/dist/types/sync-lock/memory-sync-lock.d.ts

@@ -0,0 +1,11 @@
+import { SyncLockProvider } from './sync-lock-provider';
+/**
+ * Simple in-memory implementation of the SyncLockProvider interface
+ */
+export declare class MemorySyncLock implements SyncLockProvider {
+    private _locks;
+    constructor();
+    acquireLock(lockKey: string, expirationSeconds?: number): Promise<boolean>;
+    releaseLock(lockKey: string): Promise<void>;
+    clearExpiredSyncLocks(): Promise<number>;
+}