@hdriel/aws-utils 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,320 @@
+import * as _aws_sdk_client_iam from '@aws-sdk/client-iam';
+import { IAMClient } from '@aws-sdk/client-iam';
+import { InvokeCommandOutput } from '@aws-sdk/client-lambda';
+import { Request as Request$1, Response, NextFunction, RequestHandler } from 'express';
+import { Logger } from 'stack-trace-logger';
+import { StringValue } from 'ms';
+import { Buffer } from 'buffer';
+import { Readable } from 'node:stream';
+import { S3Client, ListBucketsCommandInput, Bucket, PublicAccessBlockConfiguration, CreateBucketCommandOutput, HeadBucketCommandInput, DeleteBucketCommandOutput, PutObjectCommandOutput, DeleteObjectsCommandOutput, HeadObjectCommandOutput, DeleteObjectCommandOutput } from '@aws-sdk/client-s3';
+import { Multer } from 'multer';
+import { Unit } from 'bytes';
+
+declare class IAMUtil {
+    private readonly iam;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, debug, }?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    get client(): IAMClient;
+    getUserList(): Promise<_aws_sdk_client_iam.ListUsersCommandOutput>;
+    listUsers(maxItems?: number): Promise<_aws_sdk_client_iam.User[] | null | undefined>;
+}
+
+declare class LambdaUtil<T> {
+    private readonly lambda;
+    private readonly serviceFunctionName;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, serviceFunctionName, debug, }: {
+        serviceFunctionName: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    private directInvoke;
+    runLambdaInDryRunMode(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+    triggerLambdaEvent<T>(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+    runAndGetLambdaResponse(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+}
+
+declare enum ACLs {
+    private = "private",
+    publicRead = "public-read",
+    publicReadWrite = "public-read-write"
+}
+
+interface File {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    destination: string;
+    filename: string;
+    path: string;
+    size: number;
+}
+interface FILES3_METADATA extends File {
+    directory: string;
+}
+type FILE_EXT = 'jpg' | 'jpeg' | 'png' | 'gif' | 'bmp' | 'webp' | 'svg' | 'ico' | 'tif' | 'tiff' | 'heic' | 'heif' | 'raw' | 'cr2' | 'nef' | 'arw' | 'mp4' | 'avi' | 'mov' | 'wmv' | 'flv' | 'mkv' | 'webm' | 'mpeg' | 'mpg' | 'm4v' | '3gp' | 'ogv' | 'ts' | 'mts' | 'm2ts' | 'pdf' | 'doc' | 'docx' | 'xls' | 'xlsx' | 'ppt' | 'pptx' | 'odt' | 'ods' | 'odp' | 'rtf' | 'pages' | 'numbers' | 'key' | 'txt' | 'csv' | 'json' | 'xml' | 'md' | 'log' | 'yaml' | 'yml' | 'ini' | 'conf' | 'cfg' | 'zip' | 'rar' | '7z' | 'tar' | 'gz' | 'bz2' | 'xz' | 'iso' | 'mp3' | 'wav' | 'ogg' | 'flac' | 'aac' | 'm4a' | 'wma' | 'aiff' | 'ape' | 'opus' | 'js' | 'ts' | 'jsx' | 'tsx' | 'py' | 'java' | 'c' | 'cpp' | 'h' | 'cs' | 'php' | 'rb' | 'go' | 'rs' | 'swift' | 'kt' | 'scala' | 'html' | 'htm' | 'css' | 'scss' | 'sass' | 'less' | 'ttf' | 'otf' | 'woff' | 'woff2' | 'eot' | 'obj' | 'fbx' | 'stl' | 'dae' | 'blend' | '3ds' | 'gltf' | 'glb' | 'exe' | 'dll' | 'so' | 'dylib' | 'bin' | 'dmg' | 'pkg' | 'deb' | 'rpm' | 'apk';
+type FILE_TYPE = 'image' | 'video' | 'application' | 'text' | 'audio';
+type ByteUnitStringValue = `${number}${Unit}`;
+interface TreeFileItem {
+    name: string;
+    path: string;
+    type: 'directory' | 'file';
+    size: number;
+    lastModified: Date;
+}
+interface TreeDirectoryItem {
+    name: string;
+    path: string;
+    type: 'directory' | 'file';
+    children: Array<TreeDirectoryItem | TreeFileItem>;
+}
+
+interface ContentFile {
+    Key: string;
+    Name: string;
+    LastModified: Date;
+    ETag: string;
+    Size: number;
+    StorageClass: string;
+    Owner: {
+        DisplayName?: string;
+        ID?: string;
+    };
+}
+interface FileUploadResponse {
+    ETag: string;
+    Location: string;
+    Key: string;
+    Bucket: string;
+}
+interface UploadedS3File extends Express.Multer.File {
+    bucket: string;
+    key: string;
+    acl: string;
+    contentType: string;
+    contentDisposition: null;
+    storageClass: string;
+    serverSideEncryption: null;
+    metadata: FILES3_METADATA;
+    location: string;
+    etag: string;
+}
+interface S3UploadOptions {
+    acl?: ACLs;
+    maxFilesCount?: undefined | number | null;
+    maxFileSize?: ByteUnitStringValue | number;
+    filename?: string | ((req: Request, file: File) => string | Promise<string>);
+    fileType?: FILE_TYPE | FILE_TYPE[];
+    fileExt?: FILE_EXT | FILE_EXT[];
+    metadata?: Record<string, string> | ((req: Request, file: File) => Record<string, string> | Promise<Record<string, string>>);
+}
+interface BucketInfo {
+    name: string;
+    region: string;
+    endpoint: string;
+    exists: boolean;
+    bucketRegion?: string;
+    accessPointAlias?: boolean;
+    creationDate?: Date;
+    acl?: Array<{
+        grantee?: string;
+        permission?: string;
+    }>;
+    publicAccessBlock?: {
+        BlockPublicAcls?: boolean;
+        IgnorePublicAcls?: boolean;
+        BlockPublicPolicy?: boolean;
+        RestrictPublicBuckets?: boolean;
+    };
+    policy?: any;
+    versioning?: string;
+    encryption?: {
+        enabled: boolean;
+        type?: string;
+    };
+}
+
+declare class S3BucketUtil {
+    readonly s3Client: S3Client;
+    readonly bucket: string;
+    readonly endpoint: string;
+    readonly region: string;
+    readonly logger?: Logger;
+    readonly reqId: string | null;
+    private readonly maxUploadFileSizeRestriction;
+    constructor({ logger, bucket, reqId, accessKeyId, secretAccessKey, endpoint, region, s3ForcePathStyle, maxUploadFileSizeRestriction, }: {
+        logger?: Logger;
+        bucket: string;
+        reqId?: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        s3ForcePathStyle?: boolean;
+        maxUploadFileSizeRestriction?: ByteUnitStringValue;
+    });
+    get link(): string;
+    private execute;
+    getBucketList(options?: Partial<ListBucketsCommandInput>, includePublicAccess?: boolean): Promise<Array<Bucket & {
+        PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
+    }> | null>;
+    isBucketExists(): Promise<boolean>;
+    private initAsPublicBucket;
+    private initAsPrivateBucket;
+    initBucket(acl?: ACLs, includeConstraintLocation?: boolean): Promise<CreateBucketCommandOutput | undefined>;
+    private emptyBucket;
+    bucketInfo(options?: Partial<HeadBucketCommandInput>): Promise<BucketInfo>;
+    destroyBucket(forceDeleteAllFilesBeforeDestroyBucket?: boolean): Promise<DeleteBucketCommandOutput | undefined>;
+    createDirectory(directoryPath: string): Promise<PutObjectCommandOutput>;
+    deleteDirectory(directoryPath: string): Promise<DeleteObjectsCommandOutput | null>;
+    directoryList(directoryPath?: string): Promise<{
+        directories: string[];
+        files: ContentFile[];
+    }>;
+    /**
+     * Get all files recursively (example for search/indexing)
+     * @param directoryPath
+     */
+    directoryListRecursive(directoryPath?: string): Promise<{
+        directories: string[];
+        files: Array<ContentFile & {
+            Name: string;
+        }>;
+    }>;
+    /**
+     * Get tree files recursively (example for build file explorer UI)
+     * @param directoryPath - the directory start from
+     * @example
+     * const tree = await s3Util.getDirectoryTree('uploads');
+     * // {
+     * //   name: 'uploads',
+     * //   path: 'uploads/',
+     * //   type: 'directory',
+     * //   children: [
+     * //     {
+     * //       name: 'logo.png',
+     * //       path: 'uploads/logo.png',
+     * //       type: 'file',
+     * //       size: 12345,
+     * //       lastModified: Date
+     * //     },
+     * //     {
+     * //       name: 'images',
+     * //       path: 'uploads/images/',
+     * //       type: 'directory',
+     * //       children: [
+     * //         { name: 'photo1.jpg', type: 'file', ... },
+     * //         { name: 'photo2.jpg', type: 'file', ... }
+     * //       ]
+     * //     }
+     * //   ]
+     * // }
+     */
+    directoryTree(directoryPath?: string): Promise<TreeDirectoryItem>;
+    fileInfo(filePath: string): Promise<HeadObjectCommandOutput>;
+    fileListInfo(directoryPath?: string, fileNamePrefix?: string): Promise<ContentFile[]>;
+    taggingFile(filePath: string, tagVersion?: string): Promise<boolean>;
+    fileVersion(filePath: string): Promise<string>;
+    fileUrl(filePath: string, expiresIn?: number | StringValue): Promise<string>;
+    sizeOf(filePath: string, unit?: 'bytes' | 'KB' | 'MB' | 'GB'): Promise<number>;
+    fileExists(filePath: string): Promise<boolean>;
+    fileContent(filePath: string, format?: 'buffer' | 'base64' | 'utf8'): Promise<Buffer | string>;
+    uploadFile(filePath: string, fileData: Buffer | Readable | string | Uint8Array, acl?: ACLs, version?: string): Promise<FileUploadResponse & {
+        test: string;
+    }>;
+    deleteFile(filePath: string): Promise<DeleteObjectCommandOutput>;
+    private streamObjectFile;
+    private streamVideoFile;
+    getStreamZipFileCtr({ filePath, filename: _filename, compressionLevel, }: {
+        filePath: string | string[];
+        filename?: string;
+        compressionLevel?: number;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<void>>;
+    getStreamFileCtrl({ filePath, filename }: {
+        filePath: string;
+        filename?: string;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<void>>;
+    getStreamVideoFileCtrl({ fileKey, allowedWhitelist, contentType, streamTimeoutMS, bufferMB, }: {
+        contentType?: string;
+        fileKey: string;
+        allowedWhitelist?: string[];
+        bufferMB?: number | undefined;
+        streamTimeoutMS?: number | undefined;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<any>>;
+    private static fileFilter;
+    private getFileSize;
+    getUploadFileMW(directory?: string, { acl, maxFileSize, filename: _filename, fileType, fileExt, metadata: customMetadata, }?: S3UploadOptions): Multer;
+    /**
+     * Middleware for uploading a single file
+     * Adds the uploaded file info to req.s3File
+     */
+    uploadSingleFile(fieldName: string, directory: string, options?: S3UploadOptions): (req: Request$1 & {
+        s3File?: UploadedS3File;
+    } & any, res: Response, next: NextFunction & any) => void;
+    /**
+     * Middleware for uploading multiple files with the same field name
+     * Adds the uploaded files info to req.s3Files
+     */
+    uploadMultipleFiles(fieldName: string, directory: string, options?: S3UploadOptions): (req: Request$1 & {
+        s3Files?: UploadedS3File[];
+    } & any, res: Response, next: NextFunction & any) => void;
+    /**
+     * Middleware for uploading multiple files with different field names
+     * Adds the uploaded files info to req.s3FilesByField
+     */
+    uploadFieldsFiles(fields: Array<{
+        name: string;
+        directory: string;
+        maxCount?: number;
+        options?: S3UploadOptions;
+    }>): RequestHandler;
+    /**
+     * Middleware for uploading any files (mixed field names)
+     * Adds the uploaded files info to req.s3AllFiles
+     */
+    uploadAnyFiles(directory: string, maxCount?: number, options?: S3UploadOptions): RequestHandler;
+}
+
+declare class SNSUtil<T> {
+    private readonly sns;
+    private readonly topicArn;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, topicArn, debug, }: {
+        topicArn: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    publishTopicMessage(message: T): Promise<void>;
+}
+
+declare class AWSConfigSharingUtil {
+    static accessKeyId: string;
+    static secretAccessKey: string;
+    static endpoint: string;
+    static region: string;
+    constructor();
+    static setConfig({ accessKeyId, secretAccessKey, endpoint, region, }: {
+        accessKeyId?: string | undefined;
+        secretAccessKey?: string | undefined;
+        endpoint?: string | undefined;
+        region?: string | undefined;
+    }): void;
+    static getConfig(): {
+        accessKeyId: string;
+        secretAccessKey: string;
+        region: string;
+        endpoint: string;
+    };
+}
+
+export { ACLs, AWSConfigSharingUtil, type BucketInfo, type FILE_EXT, type FILE_TYPE, IAMUtil, LambdaUtil, S3BucketUtil, SNSUtil, type TreeDirectoryItem, type TreeFileItem, type UploadedS3File };

package/dist/index.d.ts

@@ -0,0 +1,320 @@
+import * as _aws_sdk_client_iam from '@aws-sdk/client-iam';
+import { IAMClient } from '@aws-sdk/client-iam';
+import { InvokeCommandOutput } from '@aws-sdk/client-lambda';
+import { Request as Request$1, Response, NextFunction, RequestHandler } from 'express';
+import { Logger } from 'stack-trace-logger';
+import { StringValue } from 'ms';
+import { Buffer } from 'buffer';
+import { Readable } from 'node:stream';
+import { S3Client, ListBucketsCommandInput, Bucket, PublicAccessBlockConfiguration, CreateBucketCommandOutput, HeadBucketCommandInput, DeleteBucketCommandOutput, PutObjectCommandOutput, DeleteObjectsCommandOutput, HeadObjectCommandOutput, DeleteObjectCommandOutput } from '@aws-sdk/client-s3';
+import { Multer } from 'multer';
+import { Unit } from 'bytes';
+
+declare class IAMUtil {
+    private readonly iam;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, debug, }?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    get client(): IAMClient;
+    getUserList(): Promise<_aws_sdk_client_iam.ListUsersCommandOutput>;
+    listUsers(maxItems?: number): Promise<_aws_sdk_client_iam.User[] | null | undefined>;
+}
+
+declare class LambdaUtil<T> {
+    private readonly lambda;
+    private readonly serviceFunctionName;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, serviceFunctionName, debug, }: {
+        serviceFunctionName: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    private directInvoke;
+    runLambdaInDryRunMode(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+    triggerLambdaEvent<T>(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+    runAndGetLambdaResponse(payload?: T): Promise<InvokeCommandOutput['Payload']>;
+}
+
+declare enum ACLs {
+    private = "private",
+    publicRead = "public-read",
+    publicReadWrite = "public-read-write"
+}
+
+interface File {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    destination: string;
+    filename: string;
+    path: string;
+    size: number;
+}
+interface FILES3_METADATA extends File {
+    directory: string;
+}
+type FILE_EXT = 'jpg' | 'jpeg' | 'png' | 'gif' | 'bmp' | 'webp' | 'svg' | 'ico' | 'tif' | 'tiff' | 'heic' | 'heif' | 'raw' | 'cr2' | 'nef' | 'arw' | 'mp4' | 'avi' | 'mov' | 'wmv' | 'flv' | 'mkv' | 'webm' | 'mpeg' | 'mpg' | 'm4v' | '3gp' | 'ogv' | 'ts' | 'mts' | 'm2ts' | 'pdf' | 'doc' | 'docx' | 'xls' | 'xlsx' | 'ppt' | 'pptx' | 'odt' | 'ods' | 'odp' | 'rtf' | 'pages' | 'numbers' | 'key' | 'txt' | 'csv' | 'json' | 'xml' | 'md' | 'log' | 'yaml' | 'yml' | 'ini' | 'conf' | 'cfg' | 'zip' | 'rar' | '7z' | 'tar' | 'gz' | 'bz2' | 'xz' | 'iso' | 'mp3' | 'wav' | 'ogg' | 'flac' | 'aac' | 'm4a' | 'wma' | 'aiff' | 'ape' | 'opus' | 'js' | 'ts' | 'jsx' | 'tsx' | 'py' | 'java' | 'c' | 'cpp' | 'h' | 'cs' | 'php' | 'rb' | 'go' | 'rs' | 'swift' | 'kt' | 'scala' | 'html' | 'htm' | 'css' | 'scss' | 'sass' | 'less' | 'ttf' | 'otf' | 'woff' | 'woff2' | 'eot' | 'obj' | 'fbx' | 'stl' | 'dae' | 'blend' | '3ds' | 'gltf' | 'glb' | 'exe' | 'dll' | 'so' | 'dylib' | 'bin' | 'dmg' | 'pkg' | 'deb' | 'rpm' | 'apk';
+type FILE_TYPE = 'image' | 'video' | 'application' | 'text' | 'audio';
+type ByteUnitStringValue = `${number}${Unit}`;
+interface TreeFileItem {
+    name: string;
+    path: string;
+    type: 'directory' | 'file';
+    size: number;
+    lastModified: Date;
+}
+interface TreeDirectoryItem {
+    name: string;
+    path: string;
+    type: 'directory' | 'file';
+    children: Array<TreeDirectoryItem | TreeFileItem>;
+}
+
+interface ContentFile {
+    Key: string;
+    Name: string;
+    LastModified: Date;
+    ETag: string;
+    Size: number;
+    StorageClass: string;
+    Owner: {
+        DisplayName?: string;
+        ID?: string;
+    };
+}
+interface FileUploadResponse {
+    ETag: string;
+    Location: string;
+    Key: string;
+    Bucket: string;
+}
+interface UploadedS3File extends Express.Multer.File {
+    bucket: string;
+    key: string;
+    acl: string;
+    contentType: string;
+    contentDisposition: null;
+    storageClass: string;
+    serverSideEncryption: null;
+    metadata: FILES3_METADATA;
+    location: string;
+    etag: string;
+}
+interface S3UploadOptions {
+    acl?: ACLs;
+    maxFilesCount?: undefined | number | null;
+    maxFileSize?: ByteUnitStringValue | number;
+    filename?: string | ((req: Request, file: File) => string | Promise<string>);
+    fileType?: FILE_TYPE | FILE_TYPE[];
+    fileExt?: FILE_EXT | FILE_EXT[];
+    metadata?: Record<string, string> | ((req: Request, file: File) => Record<string, string> | Promise<Record<string, string>>);
+}
+interface BucketInfo {
+    name: string;
+    region: string;
+    endpoint: string;
+    exists: boolean;
+    bucketRegion?: string;
+    accessPointAlias?: boolean;
+    creationDate?: Date;
+    acl?: Array<{
+        grantee?: string;
+        permission?: string;
+    }>;
+    publicAccessBlock?: {
+        BlockPublicAcls?: boolean;
+        IgnorePublicAcls?: boolean;
+        BlockPublicPolicy?: boolean;
+        RestrictPublicBuckets?: boolean;
+    };
+    policy?: any;
+    versioning?: string;
+    encryption?: {
+        enabled: boolean;
+        type?: string;
+    };
+}
+
+declare class S3BucketUtil {
+    readonly s3Client: S3Client;
+    readonly bucket: string;
+    readonly endpoint: string;
+    readonly region: string;
+    readonly logger?: Logger;
+    readonly reqId: string | null;
+    private readonly maxUploadFileSizeRestriction;
+    constructor({ logger, bucket, reqId, accessKeyId, secretAccessKey, endpoint, region, s3ForcePathStyle, maxUploadFileSizeRestriction, }: {
+        logger?: Logger;
+        bucket: string;
+        reqId?: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        s3ForcePathStyle?: boolean;
+        maxUploadFileSizeRestriction?: ByteUnitStringValue;
+    });
+    get link(): string;
+    private execute;
+    getBucketList(options?: Partial<ListBucketsCommandInput>, includePublicAccess?: boolean): Promise<Array<Bucket & {
+        PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
+    }> | null>;
+    isBucketExists(): Promise<boolean>;
+    private initAsPublicBucket;
+    private initAsPrivateBucket;
+    initBucket(acl?: ACLs, includeConstraintLocation?: boolean): Promise<CreateBucketCommandOutput | undefined>;
+    private emptyBucket;
+    bucketInfo(options?: Partial<HeadBucketCommandInput>): Promise<BucketInfo>;
+    destroyBucket(forceDeleteAllFilesBeforeDestroyBucket?: boolean): Promise<DeleteBucketCommandOutput | undefined>;
+    createDirectory(directoryPath: string): Promise<PutObjectCommandOutput>;
+    deleteDirectory(directoryPath: string): Promise<DeleteObjectsCommandOutput | null>;
+    directoryList(directoryPath?: string): Promise<{
+        directories: string[];
+        files: ContentFile[];
+    }>;
+    /**
+     * Get all files recursively (example for search/indexing)
+     * @param directoryPath
+     */
+    directoryListRecursive(directoryPath?: string): Promise<{
+        directories: string[];
+        files: Array<ContentFile & {
+            Name: string;
+        }>;
+    }>;
+    /**
+     * Get tree files recursively (example for build file explorer UI)
+     * @param directoryPath - the directory start from
+     * @example
+     * const tree = await s3Util.getDirectoryTree('uploads');
+     * // {
+     * //   name: 'uploads',
+     * //   path: 'uploads/',
+     * //   type: 'directory',
+     * //   children: [
+     * //     {
+     * //       name: 'logo.png',
+     * //       path: 'uploads/logo.png',
+     * //       type: 'file',
+     * //       size: 12345,
+     * //       lastModified: Date
+     * //     },
+     * //     {
+     * //       name: 'images',
+     * //       path: 'uploads/images/',
+     * //       type: 'directory',
+     * //       children: [
+     * //         { name: 'photo1.jpg', type: 'file', ... },
+     * //         { name: 'photo2.jpg', type: 'file', ... }
+     * //       ]
+     * //     }
+     * //   ]
+     * // }
+     */
+    directoryTree(directoryPath?: string): Promise<TreeDirectoryItem>;
+    fileInfo(filePath: string): Promise<HeadObjectCommandOutput>;
+    fileListInfo(directoryPath?: string, fileNamePrefix?: string): Promise<ContentFile[]>;
+    taggingFile(filePath: string, tagVersion?: string): Promise<boolean>;
+    fileVersion(filePath: string): Promise<string>;
+    fileUrl(filePath: string, expiresIn?: number | StringValue): Promise<string>;
+    sizeOf(filePath: string, unit?: 'bytes' | 'KB' | 'MB' | 'GB'): Promise<number>;
+    fileExists(filePath: string): Promise<boolean>;
+    fileContent(filePath: string, format?: 'buffer' | 'base64' | 'utf8'): Promise<Buffer | string>;
+    uploadFile(filePath: string, fileData: Buffer | Readable | string | Uint8Array, acl?: ACLs, version?: string): Promise<FileUploadResponse & {
+        test: string;
+    }>;
+    deleteFile(filePath: string): Promise<DeleteObjectCommandOutput>;
+    private streamObjectFile;
+    private streamVideoFile;
+    getStreamZipFileCtr({ filePath, filename: _filename, compressionLevel, }: {
+        filePath: string | string[];
+        filename?: string;
+        compressionLevel?: number;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<void>>;
+    getStreamFileCtrl({ filePath, filename }: {
+        filePath: string;
+        filename?: string;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<void>>;
+    getStreamVideoFileCtrl({ fileKey, allowedWhitelist, contentType, streamTimeoutMS, bufferMB, }: {
+        contentType?: string;
+        fileKey: string;
+        allowedWhitelist?: string[];
+        bufferMB?: number | undefined;
+        streamTimeoutMS?: number | undefined;
+    }): Promise<(req: Request$1 & any, res: Response & any, next: NextFunction & any) => Promise<any>>;
+    private static fileFilter;
+    private getFileSize;
+    getUploadFileMW(directory?: string, { acl, maxFileSize, filename: _filename, fileType, fileExt, metadata: customMetadata, }?: S3UploadOptions): Multer;
+    /**
+     * Middleware for uploading a single file
+     * Adds the uploaded file info to req.s3File
+     */
+    uploadSingleFile(fieldName: string, directory: string, options?: S3UploadOptions): (req: Request$1 & {
+        s3File?: UploadedS3File;
+    } & any, res: Response, next: NextFunction & any) => void;
+    /**
+     * Middleware for uploading multiple files with the same field name
+     * Adds the uploaded files info to req.s3Files
+     */
+    uploadMultipleFiles(fieldName: string, directory: string, options?: S3UploadOptions): (req: Request$1 & {
+        s3Files?: UploadedS3File[];
+    } & any, res: Response, next: NextFunction & any) => void;
+    /**
+     * Middleware for uploading multiple files with different field names
+     * Adds the uploaded files info to req.s3FilesByField
+     */
+    uploadFieldsFiles(fields: Array<{
+        name: string;
+        directory: string;
+        maxCount?: number;
+        options?: S3UploadOptions;
+    }>): RequestHandler;
+    /**
+     * Middleware for uploading any files (mixed field names)
+     * Adds the uploaded files info to req.s3AllFiles
+     */
+    uploadAnyFiles(directory: string, maxCount?: number, options?: S3UploadOptions): RequestHandler;
+}
+
+declare class SNSUtil<T> {
+    private readonly sns;
+    private readonly topicArn;
+    constructor({ accessKeyId, secretAccessKey, endpoint, region, topicArn, debug, }: {
+        topicArn: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        region?: string;
+        debug?: boolean;
+    });
+    publishTopicMessage(message: T): Promise<void>;
+}
+
+declare class AWSConfigSharingUtil {
+    static accessKeyId: string;
+    static secretAccessKey: string;
+    static endpoint: string;
+    static region: string;
+    constructor();
+    static setConfig({ accessKeyId, secretAccessKey, endpoint, region, }: {
+        accessKeyId?: string | undefined;
+        secretAccessKey?: string | undefined;
+        endpoint?: string | undefined;
+        region?: string | undefined;
+    }): void;
+    static getConfig(): {
+        accessKeyId: string;
+        secretAccessKey: string;
+        region: string;
+        endpoint: string;
+    };
+}
+
+export { ACLs, AWSConfigSharingUtil, type BucketInfo, type FILE_EXT, type FILE_TYPE, IAMUtil, LambdaUtil, S3BucketUtil, SNSUtil, type TreeDirectoryItem, type TreeFileItem, type UploadedS3File };