@pi-r/aws 0.6.1 → 0.6.3

package/README.md

@@ -1,5 +1,7 @@
 ### @pi-r/aws
 
+https://e-mc.readthedocs.io/en/latest/cloud/aws.html
+
 ### LICENSE
 
 MIT

package/client/index.d.ts

@@ -8,11 +8,13 @@ import type { ConfigurationOptions } from 'aws-sdk/lib/core';
 import type { ServiceConfigurationOptions } from 'aws-sdk/lib/service';
 import type { AttributeValue, DocumentClient } from 'aws-sdk/clients/dynamodb';
 import type { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
-import type { CreateBucketRequest } from 'aws-sdk/clients/s3';
+import type { CreateBucketRequest, DefaultRetention } from 'aws-sdk/clients/s3';
 
 declare namespace AWS {
     function isAccessDefined(credential: Pick<ConfigurationOptions, "accessKeyId" | "secretAccessKey" | "sessionToken">): boolean;
     function isEnvDefined(): boolean;
+    function isSharedCredentialsDefined(): boolean;
+    function isProviderChainDefined(): boolean;
     function isDatabaseDefined(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
     function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
     function getBucketPublicReadPolicy(bucket: string): string;
@@ -31,7 +33,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 writeMessageDefaultRetention(this: IModule, bucket: string, retention: DefaultRetention, service?: string): void;
     function parseAttributeValue(value: unknown): AttributeValue;
     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,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNoSuchBucket = exports.getBucketKey = exports.parseAttributeValue = 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;
+exports.isNoSuchBucket = exports.getBucketKey = exports.parseAttributeValue = 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.isProviderChainDefined = exports.isEnvDefined = exports.isSharedCredentialsDefined = exports.isAccessDefined = void 0;
 const aws = require("aws-sdk");
 const types_1 = require("@e-mc/types");
 const util_1 = require("@e-mc/cloud/util");
@@ -62,12 +62,20 @@ function isAccessDefined(credential) {
     return !!(credential.accessKeyId && credential.secretAccessKey || credential.sessionToken);
 }
 exports.isAccessDefined = isAccessDefined;
+function isSharedCredentialsDefined() {
+    return !!process.env.AWS_SDK_LOAD_CONFIG;
+}
+exports.isSharedCredentialsDefined = isSharedCredentialsDefined;
 function isEnvDefined() {
-    return !!(process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY || process.env.AWS_SESSION_TOKEN);
+    return !!(process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY);
 }
 exports.isEnvDefined = isEnvDefined;
+function isProviderChainDefined() {
+    return isSharedCredentialsDefined() || !!(process.env.AWS_WEB_IDENTITY_TOKEN_FILE || process.env.AWS_CONTAINER_CREDENTIALS_RELATIVE_URI || process.env.AWS_CONTAINER_CREDENTIALS_FULL_URI);
+}
+exports.isProviderChainDefined = isProviderChainDefined;
 function isDatabaseDefined(credential, data) {
-    return !!(data.table && (credential.region || credential.endpoint || process.env.AWS_DEFAULT_REGION));
+    return !!(data.table && (credential.region || credential.endpoint || process.env.AWS_DEFAULT_REGION || process.env.AWS_REGION));
 }
 exports.isDatabaseDefined = isDatabaseDefined;
 function getPublicReadPolicy(bucket, authenticated, write) {
@@ -114,7 +122,7 @@ function getPrivatePolicy(bucket) {
 }
 exports.getPrivatePolicy = getPrivatePolicy;
 function validateStorage(credential) {
-    return !!(isAccessDefined(credential) || isEnvDefined() || credential.fromPath || credential.profile || process.env.AWS_SDK_LOAD_CONFIG === '1');
+    return !!(isAccessDefined(credential) || isEnvDefined() || credential.fromPath || credential.profile || isProviderChainDefined());
 }
 exports.validateStorage = validateStorage;
 function validateDatabase(credential, data) {
@@ -130,7 +138,7 @@ function createStorageClient(credential, service = 'aws', sdk = 'aws-sdk/clients
                 client.config.loadFromPath(fromPath);
                 return client;
             }
-            if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
+            if (profile || isSharedCredentialsDefined() && !isAccessDefined(credential) && !isEnvDefined()) {
                 credential = new aws.SharedIniFileCredentials({ profile });
             }
             return new aws.S3(credential);
@@ -149,7 +157,7 @@ function createDatabaseClient(credential) {
     if (fromPath) {
         aws.config.loadFromPath(fromPath);
     }
-    else if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
+    else if (profile || isSharedCredentialsDefined() && !isAccessDefined(credential) && !isEnvDefined()) {
         options = new aws.SharedIniFileCredentials({ profile });
     }
     else {
@@ -315,7 +323,7 @@ async function executeBatchQuery(credential, batch, sessionKey) {
                     continue;
                 }
             }
-            const Key = (0, types_1.isPlainObject)(key) ? key : { [key]: parseAttributeValue(id) };
+            const Key = (0, types_1.isPlainObject)(key) ? key : { [key]: id };
             const command = { TableName, Key };
             client = createClient();
             if (update) {
@@ -330,12 +338,12 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             if (TableName) {
                 query.TableName = TableName;
             }
-            if (limit > 0) {
-                query.Limit = limit;
-            }
             if (!TableName) {
                 throw (0, util_1.formatError)(item, "Missing database table" /* ERR_DB.TABLE */);
             }
+            if (limit > 0) {
+                query.Limit = limit;
+            }
             if (useCache && (rows = getCache(queryString = Module.asString(query, true)))) {
                 result[i] = rows;
                 continue;
@@ -394,9 +402,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
 exports.executeBatchQuery = executeBatchQuery;
 function setDatabaseEndpoint(config) {
     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();
+    const endpoint = config.endpoint || (config.endpoint = `https://dynamodb.${(0, types_1.isString)(region) ? region : process.env.AWS_DEFAULT_REGION || process.env.AWS_REGION || 'us-east-1'}.amazonaws.com`);
+    if (!region) {
+        region = ((0, types_1.isString)(endpoint) && /\bdynamodb\.([^.]+)\./i.exec(endpoint)?.[1] || process.env.AWS_DEFAULT_REGION || process.env.AWS_REGION)?.toLowerCase();
         if (region && region !== 'us-east-1') {
             config.region = region;
         }
@@ -425,7 +433,7 @@ function writeMessageDefaultRetention(bucket, retention, service = 'aws') {
     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 });
+    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;
 function parseAttributeValue(value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "AWS V2 cloud functions for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/anpham6/pi-r.git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
     "directory": "src/cloud/aws"
   },
   "keywords": [
@@ -21,9 +21,9 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/cloud": "^0.8.1",
-    "@e-mc/module": "^0.8.1",
-    "@e-mc/types": "^0.8.1",
-    "aws-sdk": "^2.1531.0"
+    "@e-mc/cloud": "^0.8.3",
+    "@e-mc/module": "^0.8.3",
+    "@e-mc/types": "^0.8.3",
+    "aws-sdk": "^2.1547.0"
   }
 }

package/types/index.d.ts

@@ -3,12 +3,18 @@ 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, BatchGetItemInput, QueryInput, ScanInput, UpdateItemInput } from 'aws-sdk/clients/dynamodb';
+import type { DocumentClient } from 'aws-sdk/clients/dynamodb';
 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 | PutPublicAccessBlockRequest;
+export type Key = DocumentClient.Key;
+export type GetItemInput = DocumentClient.GetItemInput;
+export type QueryInput = DocumentClient.QueryInput;
+export type UpdateItemInput = DocumentClient.UpdateItemInput;
+export type ScanInput = DocumentClient.ScanInput;
+export type BatchGetItemInput = DocumentClient.BatchGetItemInput;
 
 export interface AWSStorageCredential extends ConfigurationOptions {
     profile?: string;

package/upload/index.js

@@ -36,7 +36,7 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
             }
             BUCKET_SESSION.add(service + Bucket);
         }
-        if (service !== 'oci') {
+        if (service !== 'ibm' && 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 => {
@@ -119,46 +119,49 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
                 }
             }
             s3.upload(params, (err, result) => {
-                if (!err) {
-                    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 (err) {
                     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);
+                        errorResponse(err);
                     }
+                    else {
+                        addLog(err);
+                    }
+                    return;
                 }
-                else if (first) {
-                    errorResponse(err);
+                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) {
+                    return;
                 }
-                else {
-                    addLog(err);
+                if (service !== 'oci') {
+                    let length = -1;
+                    if ((0, types_1.isPlainObject)(tags) && (length = Object.keys(tags).length) > 0) {
+                        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 || length === 0) {
+                        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);
             });
         }
     };