@bitblit/ratchet-aws-node-only 4.0.419-alpha → 4.0.421-alpha

package/lib/types.d.ts

@@ -1,231 +0,0 @@
-import fs, { ReadStream, WriteStream } from 'fs';
-import { AthenaClient, Row, NamedQuery } from '@aws-sdk/client-athena';
-import { S3Client, HeadObjectCommandOutput } from '@aws-sdk/client-s3';
-import { BuildInformation, RemoteFileSyncLike, RemoteStatusData, FileTransferResult, BackupResult } from '@bitblit/ratchet-common';
-import { DynamoRatchet, Ec2Ratchet, S3CacheRatchet, S3CacheRatchetLike } from '@bitblit/ratchet-aws';
-import { ScanCommandInput, QueryCommandInput } from '@aws-sdk/lib-dynamodb';
-import { AbstractRatchetCliHandler } from '@bitblit/ratchet-node-only';
-import { Instance } from '@aws-sdk/client-ec2';
-import { ParsedMail } from 'mailparser';
-
-declare class AthenaRatchet {
-    private athena;
-    private s3;
-    private outputLocation;
-    constructor(athena: AthenaClient, s3: S3Client, outputLocation: string);
-    static athenaRowsToObject<T>(input: Row[]): T[];
-    fetchQueryIds(): Promise<string[]>;
-    listQueries(): Promise<NamedQuery[]>;
-    findQueryByName(name: string): Promise<NamedQuery>;
-    runQueryToObjects<T>(queryIn: string, queryParams?: any, pingTimeMS?: number): Promise<T[]>;
-    runQueryToFile(queryIn: string, queryParams?: any, targetDataFileIn?: string, pingTimeMS?: number): Promise<string>;
-    private runQueryToOutputLocation;
-}
-
-declare class AlbAthenaLogRatchet {
-    private athena;
-    private athenaTableName;
-    constructor(athena: AthenaRatchet, athenaTableName: string);
-    updatePartitions(rootPath: string, s3: S3Client, startTimeEpochMS?: number, endTimeEpochMS?: number): Promise<string[]>;
-    createTable(rootPath: string, replaceIfPresent?: boolean): Promise<boolean>;
-    static readLogObjectsFromCsvStream(readStream: ReadStream): Promise<AlbLogRecord[]>;
-    static readLogObjectsFromFile(fileName: string): Promise<AlbLogRecord[]>;
-    fetchAlbLogRecords(qry: AlbLogRecordQuery): Promise<AlbLogRecord[]>;
-    fetchAlbLogRecordsToFile(qry: AlbLogRecordQuery, outputFileName?: string): Promise<string>;
-    static readonly CREATE_TABLE_STATEMENT: string;
-}
-interface AlbLogRecordQuery {
-    startTimeEpochMS?: number;
-    endTimeEpochMS?: number;
-    requestUrlFilter?: string;
-    limit?: number;
-}
-interface AlbLogRecord {
-    type: string;
-    time: string;
-    elb: string;
-    client_ip: string;
-    client_port: string;
-    target_ip: string;
-    target_port: string;
-    request_processing_time: string;
-    target_processing_time: string;
-    response_processing_time: string;
-    elb_status_code: string;
-    target_status_code: string;
-    received_bytes: string;
-    sent_bytes: string;
-    request_verb: string;
-    request_url: string;
-    request_proto: string;
-    user_agent: string;
-    ssl_cipher: string;
-    ssl_protocol: string;
-    target_group_arn: string;
-    trace_id: string;
-    domain_name: string;
-    chosen_cert_arn: string;
-    matched_rule_priority: string;
-    request_creation_time: string;
-    actions_executed: string;
-    redirect_url: string;
-    lambda_error_reason: string;
-    target_port_list: string;
-    target_status_code_list: string;
-    new_field: string;
-    date_utc_partition: string;
-}
-
-declare class RatchetAwsNodeOnlyInfo {
-    private constructor();
-    static buildInformation(): BuildInformation;
-}
-
-declare class DynamoExporter {
-    private constructor();
-    static importJsonLFileToTable(dynamo: DynamoRatchet, tableName: string, filename: string): Promise<number>;
-    static exportScanToJsonLFile(dynamo: DynamoRatchet, scan: ScanCommandInput, filename: string): Promise<number>;
-    static exportQueryToJsonLFile(dynamo: DynamoRatchet, qry: QueryCommandInput, filename: string): Promise<number>;
-    static exportScanToJsonLWriteStream(dynamo: DynamoRatchet, scan: ScanCommandInput, target: WriteStream): Promise<number>;
-    static exportQueryToJsonLWriteStream(dynamo: DynamoRatchet, qry: QueryCommandInput, target: WriteStream): Promise<number>;
-    static writeItemToJsonLStream(item: any, target: WriteStream, includeNulls?: boolean): void;
-}
-
-declare class RatchetCliHandler extends AbstractRatchetCliHandler {
-    fetchHandlerMap(): Record<string, any>;
-    fetchVersionInfo(): BuildInformation;
-}
-
-declare class StartInstanceAndSsh {
-    private instanceId;
-    private publicKeyFile;
-    private instanceOsUser;
-    private region;
-    private availabilityZone;
-    private ec2Ratchet;
-    private instanceUtil;
-    constructor(instanceId: string, publicKeyFile?: string, instanceOsUser?: string, region?: string, availabilityZone?: string);
-    static createFromArgs(args: string[]): StartInstanceAndSsh;
-    static runFromCliArgs(args: string[]): Promise<void>;
-    run(): Promise<any>;
-}
-
-declare class SiteUploader {
-    private srcDir;
-    private bucketName;
-    private config;
-    private readonly s3;
-    constructor(srcDir: string, bucketName: string, configFile: string);
-    static createFromArgs(args: string[]): SiteUploader;
-    static runFromCliArgs(args: string[]): Promise<void>;
-    findMatch(prefix: string, fileName: string, config: any): any;
-    findMime(fileName: string, config: any): string;
-    runPump(): Promise<any>;
-}
-
-declare class Ec2InstanceUtil {
-    private ec2Ratchet;
-    constructor(ec2Ratchet: Ec2Ratchet);
-    startInstanceAndUploadPublicKeyFile(instanceId: string, filePath: string, instanceOsUser?: string): Promise<Instance>;
-    startInstanceAndUploadPublicKey(instanceId: string, publicKeyText: string, instanceOsUser?: string): Promise<Instance>;
-}
-
-interface ParsedEmailProcessor<T> {
-    canProcess(mail: ParsedMail): boolean;
-    processEmail(msg: ParsedMail): Promise<T>;
-}
-
-declare class EmailToDbInsertProcessor implements ParsedEmailProcessor<EmailToDbStatement[]> {
-    canProcess(mail: ParsedMail): boolean;
-    processEmail(msg: ParsedMail): Promise<EmailToDbStatement[]>;
-}
-interface EmailToDbStatement {
-    statement: string;
-    params?: any[];
-}
-
-declare class InboundEmailRatchet {
-    private cache;
-    private processors;
-    constructor(cache: S3CacheRatchet, processors: ParsedEmailProcessor<any>[]);
-    processEmailFromS3(key: string): Promise<boolean>;
-    processEmailFromBuffer(buf: Buffer): Promise<boolean>;
-}
-
-declare class SampleEmailProcessor implements ParsedEmailProcessor<string> {
-    canProcess(mail: ParsedMail): boolean;
-    processEmail(msg: ParsedMail): Promise<string>;
-}
-
-declare class S3CacheToLocalDiskRatchet {
-    private s3;
-    private tmpFolder;
-    private cacheTimeoutSeconds;
-    private static readonly DEFAULT_CACHE_TIMEOUT_SEC;
-    private currentlyLoading;
-    constructor(s3: S3CacheRatchetLike, 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;
-}
-
-declare enum S3SyncedFileConfigInitMode {
-    Lazy = "Lazy",
-    OnStartup = "OnStartup"
-}
-
-declare enum S3SyncedFileRemoteBackupMode {
-    EveryUpload = "EveryUpload",
-    Disabled = "Disabled"
-}
-
-declare enum S3SyncedFileOptimization {
-    TreatSameSizeAsNoChange = "TreatSameSizeAsNoChange"
-}
-
-interface S3SyncedFileConfig {
-    s3CacheRatchetLike: S3CacheRatchetLike;
-    s3Path: string;
-    forceLocalFileFullPath?: string;
-    initMode: S3SyncedFileConfigInitMode;
-    backupMode?: S3SyncedFileRemoteBackupMode;
-    fetchOptimizations?: S3SyncedFileOptimization[];
-    pushOptimizations?: S3SyncedFileOptimization[];
-    remoteStatusTtlMs?: number;
-    leaveTempFileOnDisk?: boolean;
-}
-
-declare class S3SyncedFile implements RemoteFileSyncLike {
-    private config;
-    private readonly _localFileName;
-    private _remoteStatus;
-    private _lastSyncEpochMS;
-    private _loadingRemoteSignal;
-    constructor(config: S3SyncedFileConfig);
-    get remoteStatusData(): Promise<RemoteStatusData>;
-    private initialize;
-    localAndRemoteAreSameSize(): Promise<boolean>;
-    directWriteValueToLocalFile(value: string | Uint8Array): void;
-    get lastSyncEpochMS(): number;
-    get localFileName(): string;
-    get localFileStats(): fs.Stats;
-    get localFileBytes(): number;
-    get localFileUpdatedEpochMS(): number;
-    fetchRemoteMeta(): Promise<HeadObjectCommandOutput>;
-    get wouldFetch(): Promise<boolean>;
-    get wouldPush(): Promise<boolean>;
-    sendLocalToRemote(): Promise<FileTransferResult>;
-    backupRemote(): Promise<BackupResult>;
-    fetchRemoteToLocal(): Promise<FileTransferResult>;
-    fetchRemoteToLocalIfNewerThan(epochMS: number): Promise<FileTransferResult>;
-    private hasFetchOptimization;
-    private hasPushOptimization;
-    private innerFetchRemoteToLocalIfNewerThan;
-}
-
-export { AlbAthenaLogRatchet, type AlbLogRecord, type AlbLogRecordQuery, AthenaRatchet, DynamoExporter, Ec2InstanceUtil, EmailToDbInsertProcessor, type EmailToDbStatement, InboundEmailRatchet, type ParsedEmailProcessor, RatchetAwsNodeOnlyInfo, RatchetCliHandler, S3CacheToLocalDiskRatchet, S3SyncedFile, type S3SyncedFileConfig, S3SyncedFileConfigInitMode, S3SyncedFileOptimization, S3SyncedFileRemoteBackupMode, SampleEmailProcessor, SiteUploader, StartInstanceAndSsh };