@pi-r/aws 0.2.2 → 0.5.0

package/client/index.d.ts

@@ -31,6 +31,7 @@ declare namespace AWS {
     function executeBatchQuery(this: ICloud, credential: AWSDatabaseCredential, batch: AWSDatabaseQuery[], sessionKey?: string): Promise<BatchQueryResult>;
     function setDatabaseEndpoint(config: ServiceConfigurationOptions | DynamoDBClientConfig): void;
     function checkBucketCannedACL(value: unknown): BucketCannedACL | undefined;
+    function writeMessageDefaultRetention(this: IModule, bucket: string, retention: s3.DefaultRetention, service?: string): void;
     function getBucketKey(credential: unknown, Bucket: string, acl: string | undefined, service: string, sdk: string): string;
     function isNoSuchBucket(err: unknown): boolean;
 }

package/client/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNoSuchBucket = exports.getBucketKey = exports.checkBucketCannedACL = exports.setDatabaseEndpoint = exports.executeBatchQuery = exports.executeQuery = exports.deleteObjectsV2 = exports.deleteObjects = exports.setBucketWebsite = exports.setBucketPolicy = exports.createBucketV2 = exports.createBucket = exports.createDatabaseClient = exports.createStorageClient = exports.validateDatabase = exports.validateStorage = exports.getPrivatePolicy = exports.getBucketPublicReadPolicy = exports.getPublicReadPolicy = exports.isDatabaseDefined = exports.isEnvDefined = exports.isAccessDefined = void 0;
+exports.isNoSuchBucket = exports.getBucketKey = exports.writeMessageDefaultRetention = exports.checkBucketCannedACL = exports.setDatabaseEndpoint = exports.executeBatchQuery = exports.executeQuery = exports.deleteObjectsV2 = exports.deleteObjects = exports.setBucketWebsite = exports.setBucketPolicy = exports.createBucketV2 = exports.createBucket = exports.createDatabaseClient = exports.createStorageClient = exports.validateDatabase = exports.validateStorage = exports.getPrivatePolicy = exports.getBucketPublicReadPolicy = exports.getPublicReadPolicy = exports.isDatabaseDefined = exports.isEnvDefined = exports.isAccessDefined = void 0;
+const aws = require("aws-sdk");
 const types_1 = require("@e-mc/types");
 const util_1 = require("@e-mc/cloud/util");
 const Module = require("@e-mc/module");
@@ -123,20 +124,18 @@ exports.validateDatabase = validateDatabase;
 function createStorageClient(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
     try {
         if (service === 'aws') {
-            const S3 = require('aws-sdk/clients/s3');
-            if (credential.fromPath) {
-                const client = new S3();
-                client.config.loadFromPath(credential.fromPath);
+            const { profile, fromPath } = credential;
+            if (fromPath) {
+                const client = new aws.S3();
+                client.config.loadFromPath(fromPath);
                 return client;
             }
-            if (credential.profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
-                const { SharedIniFileCredentials } = require('aws-sdk');
-                credential = new SharedIniFileCredentials({ profile: credential.profile });
+            if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
+                credential = new aws.SharedIniFileCredentials({ profile });
             }
-            return new S3(credential);
+            return new aws.S3(credential);
         }
-        const S3 = require(sdk);
-        return new S3(credential);
+        return new (require(sdk))(credential);
     }
     catch (err) {
         this.checkPackage(err, sdk.split('/')[0], { passThrough: true });
@@ -145,26 +144,18 @@ function createStorageClient(credential, service = 'aws', sdk = 'aws-sdk/clients
 }
 exports.createStorageClient = createStorageClient;
 function createDatabaseClient(credential) {
-    try {
-        let options;
-        if (credential.fromPath) {
-            const AWS = require('aws-sdk');
-            AWS.config.loadFromPath(credential.fromPath);
-        }
-        else if (credential.profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
-            const { SharedIniFileCredentials } = require('aws-sdk');
-            options = new SharedIniFileCredentials({ profile: credential.profile });
-        }
-        else {
-            options = credential;
-        }
-        const DynamoDB = require('aws-sdk/clients/dynamodb');
-        return new DynamoDB.DocumentClient(options);
+    const { profile, fromPath } = credential;
+    let options;
+    if (fromPath) {
+        aws.config.loadFromPath(fromPath);
     }
-    catch (err) {
-        this.checkPackage(err, 'aws-sdk', { passThrough: true });
-        throw err;
+    else if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
+        options = new aws.SharedIniFileCredentials({ profile });
     }
+    else {
+        options = credential;
+    }
+    return new aws.DynamoDB.DocumentClient(options);
 }
 exports.createDatabaseClient = createDatabaseClient;
 function createBucket(credential, Bucket, publicRead, service = 'aws', sdk = 'aws-sdk/clients/s3') {
@@ -184,8 +175,8 @@ function createBucketV2(credential, Bucket, ACL, options, service = 'aws', sdk =
         .catch(() => {
         const input = { ...options, Bucket };
         const region = credential.region;
-        if (!input.CreateBucketConfiguration && typeof region === 'string' && (region !== 'us-east-1' || service !== 'aws')) {
-            input.CreateBucketConfiguration = { LocationConstraint: region };
+        if (region && (region !== 'us-east-1' || service !== 'aws')) {
+            input.CreateBucketConfiguration || (input.CreateBucketConfiguration = { LocationConstraint: region });
         }
         return S3.createBucket(input).promise()
             .then(async () => {
@@ -212,13 +203,14 @@ function createBucketV2(credential, Bucket, ACL, options, service = 'aws', sdk =
 }
 exports.createBucketV2 = createBucketV2;
 function setBucketPolicy(credential, Bucket, options, service = 'aws', sdk = 'aws-sdk/clients/s3') {
+    const ibm = service === 'ibm';
     const S3 = createStorageClient.call(this, credential, service, sdk);
     options.Bucket = Bucket;
-    if (service === 'ibm' && 'ACL' in options && options.ACL === 'authenticated-read') {
+    if (ibm && 'ACL' in options && options.ACL === 'authenticated-read') {
         options.AccessControlPolicy = ACP_AUTHENTICATEDREAD;
         delete options.ACL;
     }
-    return ('Policy' in options && (0, types_1.isString)(options.Policy) && service !== 'ibm' ? S3.putBucketPolicy(options) : S3.putBucketAcl(options)).promise()
+    return ('PublicAccessBlockConfiguration' in options ? S3.putPublicAccessBlock(options) : 'Policy' in options && (0, types_1.isString)(options.Policy) && !ibm ? S3.putBucketPolicy(options) : S3.putBucketAcl(options)).promise()
         .then(() => {
         this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, ["Bucket policy configured" /* VAL_CLOUD.POLICY_BUCKET */, Bucket], '', { ...Cloud.LOG_CLOUD_COMMAND });
         return true;
@@ -234,11 +226,12 @@ exports.setBucketPolicy = setBucketPolicy;
 function setBucketWebsite(credential, Bucket, options, service = 'aws', sdk = 'aws-sdk/clients/s3') {
     const S3 = createStorageClient.call(this, credential, service, sdk);
     const WebsiteConfiguration = {};
-    if ((0, types_1.isString)(options.indexPage)) {
-        WebsiteConfiguration.IndexDocument = { Suffix: options.indexPage };
+    const { indexPage: Suffix, errorPage: Key } = options;
+    if ((0, types_1.isString)(Suffix)) {
+        WebsiteConfiguration.IndexDocument = { Suffix };
     }
-    if ((0, types_1.isString)(options.errorPage)) {
-        WebsiteConfiguration.ErrorDocument = { Key: options.errorPage };
+    if ((0, types_1.isString)(Key)) {
+        WebsiteConfiguration.ErrorDocument = { Key };
     }
     return S3.putBucketWebsite({ Bucket, WebsiteConfiguration }).promise()
         .then(() => {
@@ -268,8 +261,9 @@ async function deleteObjectsV2(credential, Bucket, recursive = true, service = '
             }
             return S3.deleteObjects({ Bucket, Delete: { Objects } }).promise()
                 .then(data => {
-                if ((0, types_1.isArray)(data.Deleted)) {
-                    const files = data.Deleted.length + ' files';
+                const Deleted = data.Deleted;
+                if ((0, types_1.isArray)(Deleted)) {
+                    const files = Deleted.length + ' files';
                     this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, ["Bucket emptied" /* VAL_CLOUD.EMPTY_BUCKET */ + ` (${recursive ? 'recursive' : files})`, Bucket], recursive ? files : '', { ...Cloud.LOG_CLOUD_COMMAND });
                 }
             })
@@ -328,9 +322,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             if (update) {
                 await client.update({ ...command, ...update }).promise();
             }
-            const output = await client.get(command).promise();
-            if (output.Item) {
-                rows = [output.Item];
+            const Item = (await client.get(command).promise()).Item;
+            if (Item) {
+                rows = [Item];
             }
         }
         else if ((0, types_1.isPlainObject)(query)) {
@@ -342,9 +336,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             if (limit > 0) {
                 query.Limit = limit;
             }
-            const output = await createClient().query(query).promise();
-            if (output.Count && output.Items) {
-                rows = output.Items;
+            const { Count, Items } = await createClient().query(query).promise();
+            if (Count && Items) {
+                rows = Items;
             }
         }
         else {
@@ -356,9 +350,10 @@ async function executeBatchQuery(credential, batch, sessionKey) {
 }
 exports.executeBatchQuery = executeBatchQuery;
 function setDatabaseEndpoint(config) {
-    config.endpoint || (config.endpoint = `https://dynamodb.${(0, types_1.isString)(config.region) ? config.region : process.env.AWS_DEFAULT_REGION || 'us-east-1'}.amazonaws.com`);
-    if (!config.region && (0, types_1.isString)(config.endpoint)) {
-        const region = (/dynamodb\.([^.]+)\./i.exec(config.endpoint)?.[1] || process.env.AWS_DEFAULT_REGION)?.toLowerCase();
+    let region = config.region;
+    config.endpoint || (config.endpoint = `https://dynamodb.${(0, types_1.isString)(region) ? region : process.env.AWS_DEFAULT_REGION || 'us-east-1'}.amazonaws.com`);
+    if (!region && (0, types_1.isString)(config.endpoint)) {
+        region = (/dynamodb\.([^.]+)\./i.exec(config.endpoint)?.[1] || process.env.AWS_DEFAULT_REGION)?.toLowerCase();
         if (region && region !== 'us-east-1') {
             config.region = region;
         }
@@ -375,6 +370,21 @@ function checkBucketCannedACL(value) {
     }
 }
 exports.checkBucketCannedACL = checkBucketCannedACL;
+function writeMessageDefaultRetention(bucket, retention, service = 'aws') {
+    const { Years = 0, Days = 0, Mode } = retention;
+    const status = [];
+    if (Years > 0) {
+        status.push(Years.toString() + 'Y');
+    }
+    if (Days > 0) {
+        status.push(Days.toString() + 'D');
+    }
+    if (Mode) {
+        status.push(status.length ? `(${Mode})` : Mode);
+    }
+    this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, ["Bucket configured" /* VAL_CLOUD.CONFIGURE_BUCKET */ + ' (retention policy)', bucket], status.join(' '), { ...Cloud.LOG_CLOUD_COMMAND });
+}
+exports.writeMessageDefaultRetention = writeMessageDefaultRetention;
 const getBucketKey = (credential, Bucket, acl, service, sdk) => Module.asString(credential, true) + Bucket + '_' + (acl || '') + service + sdk;
 exports.getBucketKey = getBucketKey;
 const isNoSuchBucket = (err) => err instanceof Error && err.code === 'NoSuchBucket';

package/download/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
 const types_1 = require("@e-mc/types");
 const Module = require("@e-mc/module");
 const Cloud = require("@e-mc/cloud");
+const client_1 = require("../client");
 function download(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
     const s3 = client_1.createStorageClient.call(this, credential, service, sdk);
     return (data, callback) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws",
-  "version": "0.2.2",
+  "version": "0.5.0",
   "description": "AWS V2 cloud functions for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -21,9 +21,9 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/cloud": "^0.5.3",
-    "@e-mc/module": "^0.5.3",
-    "@e-mc/types": "^0.5.3",
-    "aws-sdk": "^2.1380.0"
+    "@e-mc/cloud": "^0.7.0",
+    "@e-mc/module": "^0.7.0",
+    "@e-mc/types": "^0.7.0",
+    "aws-sdk": "^2.1514.0"
   }
 }

package/types/index.d.ts

@@ -4,11 +4,11 @@ import type { CloudDatabase } from '@e-mc/types/lib/cloud';
 import type { ConfigurationOptions } from 'aws-sdk/lib/core';
 import type { ServiceConfigurationOptions } from 'aws-sdk/lib/service';
 import type { Key, QueryInput, UpdateItemInput } from 'aws-sdk/clients/dynamodb';
-import type { PutBucketAclRequest, PutBucketPolicyRequest } from 'aws-sdk/clients/s3';
+import type { PutBucketAclRequest, PutBucketPolicyRequest, PutPublicAccessBlockRequest } from 'aws-sdk/clients/s3';
 
 export type BucketCannedACL = "authenticated-read" | "private" | "public-read" | "public-read-write";
 export type ObjectCannedACL = BucketCannedACL | "aws-exec-read" | "bucket-owner-full-control" | "bucket-owner-read";
-export type ConfigureBucketOptions = PutBucketAclRequest | PutBucketPolicyRequest;
+export type ConfigureBucketOptions = PutBucketAclRequest | PutBucketPolicyRequest | PutPublicAccessBlockRequest;
 
 export interface AWSStorageCredential extends ConfigurationOptions {
     profile?: string;

package/upload/index.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
 const fs = require("fs");
-const client_1 = require("../client");
 const util_1 = require("@e-mc/cloud/util");
 const types_1 = require("@e-mc/types");
 const Module = require("@e-mc/module");
 const Cloud = require("@e-mc/cloud");
+const client_1 = require("../client");
 const BUCKET_SESSION = new Set();
 const BUCKET_RESPONSE = {};
 function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
@@ -14,7 +14,7 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
     return async (data, callback) => {
         var _a;
         const { bucket: Bucket, localUri } = data;
-        const { pathname = '', fileGroup, contentType, metadata, endpoint, active, publicRead, acl, admin = {}, overwrite, options } = data.upload;
+        const { pathname = '', fileGroup, contentType, metadata, tags, endpoint, active, publicRead, acl, admin = {}, overwrite, options } = data.upload;
         let filename = data.upload.filename || path.basename(localUri), bucketKey;
         const cleanup = () => {
             BUCKET_SESSION.delete(service + Bucket);
@@ -26,15 +26,30 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
             cleanup();
             callback(err);
         };
+        const addLog = (err) => err instanceof Error && this.addLog(this.statusType.WARN, err.message, service + ': ' + Bucket);
+        const configBucket = admin.configBucket;
         if (!BUCKET_SESSION.has(service + Bucket)) {
             const bucketAcl = admin.publicRead ? 'public-read' : admin.acl;
-            const response = BUCKET_RESPONSE[_a = bucketKey = (0, client_1.getBucketKey)(credential, Bucket, bucketAcl, service, sdk)] || (BUCKET_RESPONSE[_a] = client_1.createBucketV2.call(this, credential, Bucket, bucketAcl, admin.configBucket?.create, service, sdk));
+            const response = BUCKET_RESPONSE[_a = bucketKey = (0, client_1.getBucketKey)(credential, Bucket, bucketAcl, service, sdk)] || (BUCKET_RESPONSE[_a] = client_1.createBucketV2.call(this, credential, Bucket, bucketAcl, configBucket?.create, service, sdk));
             if (!await response) {
                 errorResponse(null);
                 return;
             }
             BUCKET_SESSION.add(service + Bucket);
         }
+        if (service !== 'oci') {
+            const DefaultRetention = configBucket?.retentionPolicy;
+            if ((0, types_1.isPlainObject)(DefaultRetention)) {
+                s3.putObjectLockConfiguration({ Bucket, ObjectLockConfiguration: { ObjectLockEnabled: 'Enabled', Rule: { DefaultRetention } }, ExpectedBucketOwner: options?.ExpectedBucketOwner, RequestPayer: options?.RequestPayer }, err => {
+                    if (!err) {
+                        client_1.writeMessageDefaultRetention.call(this, Bucket, DefaultRetention, service);
+                    }
+                    else {
+                        addLog(err);
+                    }
+                });
+            }
+        }
         if (!overwrite) {
             const current = filename;
             const next = (0, util_1.generateFilename)(filename);
@@ -65,7 +80,6 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
         const Key = [filename];
         const Body = [data.buffer];
         const ContentType = [contentType];
-        const addLog = (err) => err instanceof Error && this.addLog(this.statusType.WARN, err.message, service + ': ' + Bucket);
         if (fileGroup) {
             for (const [content, ext, localFile] of fileGroup) {
                 try {
@@ -115,6 +129,32 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
                     const url = endpoint ? Module.joinPath(endpoint, result.Key) : result.Location;
                     this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, "Upload success" /* VAL_CLOUD.UPLOAD_FILE */, url, { ...Cloud.LOG_CLOUD_UPLOAD });
                     if (first) {
+                        if (service !== 'oci') {
+                            if ((0, types_1.isPlainObject)(tags)) {
+                                const TagSet = [];
+                                for (const name in tags) {
+                                    TagSet.push({ Key: name, Value: tags[name] });
+                                }
+                                s3.putObjectTagging({ Bucket, Key: result.Key, Tagging: { TagSet }, ExpectedBucketOwner: params.ExpectedBucketOwner, RequestPayer: params.RequestPayer }, error => {
+                                    if (!error) {
+                                        this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, ["Tags created" /* VAL_CLOUD.CREATE_TAG */, Bucket], result.Key, { ...Cloud.LOG_CLOUD_COMMAND });
+                                    }
+                                    else {
+                                        addLog(error);
+                                    }
+                                });
+                            }
+                            else if (tags === false) {
+                                s3.deleteObjectTagging({ Bucket, Key: result.Key, ExpectedBucketOwner: params.ExpectedBucketOwner }, error => {
+                                    if (!error) {
+                                        this.formatMessage(64 /* LOG_TYPE.CLOUD */, service, ["Tags deleted" /* VAL_CLOUD.DELETE_TAG */, Bucket], result.Key, { ...Cloud.LOG_CLOUD_COMMAND });
+                                    }
+                                    else {
+                                        addLog(error);
+                                    }
+                                });
+                            }
+                        }
                         cleanup();
                         callback(null, url);
                     }