@bitblit/ratchet-aws 4.0.183-alpha → 4.0.184-alpha

package/lib/runtime-parameter/runtime-parameter-provider.d.ts

@@ -0,0 +1,6 @@
+import { StoredRuntimeParameter } from './stored-runtime-parameter.js';
+export interface RuntimeParameterProvider {
+    readParameter(groupId: string, paramKey: string): Promise<StoredRuntimeParameter>;
+    readAllParametersForGroup(groupId: string): Promise<StoredRuntimeParameter[]>;
+    writeParameter(param: StoredRuntimeParameter): Promise<boolean>;
+}

package/lib/runtime-parameter/runtime-parameter-ratchet.d.ts

@@ -0,0 +1,15 @@
+import { RuntimeParameterProvider } from './runtime-parameter-provider.js';
+import { StoredRuntimeParameter } from './stored-runtime-parameter.js';
+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/lib/runtime-parameter/runtime-parameter-ratchet.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/runtime-parameter/stored-runtime-parameter.d.ts

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

package/lib/s3/expanded-file-children.d.ts

@@ -0,0 +1,5 @@
+export interface ExpandedFileChildren {
+    link: string;
+    name: string;
+    size: number;
+}

package/lib/s3/s3-cache-ratchet-like.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Readable } from 'stream';
+import { CompleteMultipartUploadCommandOutput, CopyObjectCommandOutput, DeleteObjectCommandOutput, GetObjectCommandOutput, HeadObjectCommandOutput, PutObjectCommandInput, S3Client } from '@aws-sdk/client-s3';
+export interface S3CacheRatchetLike {
+    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, 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?: S3CacheRatchetLike, recurseSubFolders?: boolean): Promise<string[]>;
+    preSignedDownloadUrlForCacheFile(key: string, expirationSeconds?: number, bucket?: string): 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>;
+    directChildrenOfPrefix(prefix: string, expandFiles?: boolean, bucket?: string, maxToReturn?: number): Promise<string[]>;
+    allSubFoldersOfPrefix(prefix: string, bucket?: string): Promise<string[]>;
+}

package/lib/s3/s3-cache-ratchet.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { CompleteMultipartUploadCommandOutput, CopyObjectCommandOutput, DeleteObjectCommandOutput, GetObjectCommandOutput, HeadObjectCommandOutput, PutObjectCommandInput, S3Client } from '@aws-sdk/client-s3';
+import { Readable } from 'stream';
+import { S3CacheRatchetLike } from './s3-cache-ratchet-like.js';
+export declare class S3CacheRatchet implements S3CacheRatchetLike {
+    private s3;
+    private defaultBucket;
+    constructor(s3: S3Client, defaultBucket?: string);
+    get s3Client(): S3Client;
+    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, 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?: S3CacheRatchetLike, 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;
+}

package/lib/s3/s3-cache-ratchet.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/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/lib/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/lib/s3/s3-ratchet.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/ses/email-attachment.d.ts

@@ -0,0 +1,5 @@
+export interface EmailAttachment {
+    filename?: string;
+    contentType?: string;
+    base64Data?: string;
+}

package/lib/ses/mailer-config.d.ts

@@ -0,0 +1,12 @@
+import { RatchetTemplateRenderer } from '@bitblit/ratchet-common';
+import { S3CacheRatchetLike } from '../s3/s3-cache-ratchet-like.js';
+export interface MailerConfig {
+    defaultSendingAddress?: string;
+    autoBccAddresses?: string[];
+    templateRenderer?: RatchetTemplateRenderer;
+    allowedDestinationEmails?: RegExp[];
+    archive?: S3CacheRatchetLike;
+    archivePrefix?: string;
+    maxMessageBodySizeInBytes?: number;
+    maxAttachmentSizeInBase64Bytes?: number;
+}

package/lib/ses/mailer-like.d.ts

@@ -0,0 +1,11 @@
+import { ReadyToSendEmail } from './ready-to-send-email.js';
+import { SendRawEmailResponse } from '@aws-sdk/client-ses';
+import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
+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/lib/ses/mailer.d.ts

@@ -0,0 +1,20 @@
+import { ReadyToSendEmail } from './ready-to-send-email.js';
+import { SendRawEmailCommandOutput, SendRawEmailResponse, SESClient } from '@aws-sdk/client-ses';
+import { MailerConfig } from './mailer-config.js';
+import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
+import { MailerLike } from './mailer-like.js';
+export declare class Mailer implements MailerLike {
+    private ses;
+    private config;
+    static readonly EMAIL: RegExp;
+    constructor(ses: SESClient, config?: MailerConfig);
+    get sESClient(): SESClient;
+    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/lib/ses/mailer.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/ses/ready-to-send-email.d.ts

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

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

@@ -0,0 +1,5 @@
+import { ReadyToSendEmail } from './ready-to-send-email.js';
+export interface ResolvedReadyToSendEmail extends ReadyToSendEmail {
+    srcDestinationAddresses?: string[];
+    srcBccAddresses?: string[];
+}

package/lib/sns/sns-ratchet.d.ts

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

package/lib/sns/sns-ratchet.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sync-lock/dynamo-db-sync-lock.d.ts

@@ -0,0 +1,10 @@
+import { DynamoRatchet } from '../dynamodb/dynamo-ratchet.js';
+import { SyncLockProvider } from './sync-lock-provider.js';
+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/lib/sync-lock/dynamo-db-sync-lock.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sync-lock/memory-sync-lock.d.ts

@@ -0,0 +1,8 @@
+import { SyncLockProvider } from './sync-lock-provider.js';
+export declare class MemorySyncLock implements SyncLockProvider {
+    private _locks;
+    constructor();
+    acquireLock(lockKey: string, expirationSeconds?: number): Promise<boolean>;
+    releaseLock(lockKey: string): Promise<void>;
+    clearExpiredSyncLocks(): Promise<number>;
+}

package/lib/sync-lock/sync-lock-provider.d.ts

@@ -0,0 +1,5 @@
+export interface SyncLockProvider {
+    acquireLock(lockKey: string, expirationSeconds?: number): Promise<boolean>;
+    releaseLock(lockKey: string): Promise<void>;
+    clearExpiredSyncLocks?(): Promise<number>;
+}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@bitblit/ratchet-aws",
-  "version": "4.0.183-alpha",
+  "version": "4.0.184-alpha",
   "description": "Common tools for use with AWS browser and node",
   "sideEffects": false,
   "type": "module",
   "module": "./lib/index.mjs",
   "types": "./lib/index.d.ts",
   "files": [
-    "lib/*",
-    "bin/*"
+    "lib/**",
+    "bin/**"
   ],
   "exports": {
     ".": {
@@ -52,7 +52,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@bitblit/ratchet-common": "4.0.183-alpha"
+    "@bitblit/ratchet-common": "4.0.184-alpha"
   },
   "optionalDependencies": {
     "@aws-sdk/abort-controller": "3.357.0",
@@ -95,7 +95,7 @@
     "@aws-sdk/smithy-client": "^3.357.0",
     "@aws-sdk/types": "^3.357.0",
     "@aws-sdk/util-waiter": "^3.357.0",
-    "@bitblit/ratchet-common": "4.0.183-alpha"
+    "@bitblit/ratchet-common": "4.0.184-alpha"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/abort-controller": {
@@ -157,8 +157,8 @@
     }
   },
   "devDependencies": {
-    "@bitblit/ratchet-jest": "4.0.183-alpha",
-    "@bitblit/ratchet-node-only": "4.0.183-alpha",
+    "@bitblit/ratchet-jest": "4.0.184-alpha",
+    "@bitblit/ratchet-node-only": "4.0.184-alpha",
     "@types/aws-lambda": "8.10.119",
     "aws-sdk-client-mock": "3.0.0"
   }