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

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

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

package/lib/model/dynamo-count-result.d.ts

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

package/lib/route53/route-53-ratchet.d.ts

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

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

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

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

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

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

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

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

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

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

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

@@ -1,6 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

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

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

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

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

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

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

@@ -1,26 +0,0 @@
-/// <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

@@ -1,34 +0,0 @@
-/// <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

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

package/lib/s3/s3-location-sync-ratchet.d.ts

@@ -1,21 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

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

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

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

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

@@ -1,12 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

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

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

@@ -1,13 +0,0 @@
-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

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

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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,10 +0,0 @@
-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

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

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

@@ -1,8 +0,0 @@
-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

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