@pi-r/aws 0.6.0 → 0.6.2

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

@@ -6,13 +6,15 @@ import type { AWSDatabaseCredential, AWSDatabaseQuery, AWSStorageCredential, Buc
 
 import type { ConfigurationOptions } from 'aws-sdk/lib/core';
 import type { ServiceConfigurationOptions } from 'aws-sdk/lib/service';
-import type { DocumentClient } from 'aws-sdk/clients/dynamodb';
+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';
 
 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;
@@ -32,6 +34,7 @@ declare namespace AWS {
     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 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.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 {
@@ -284,39 +292,39 @@ async function executeQuery(credential, data, sessionKey) {
 }
 exports.executeQuery = executeQuery;
 async function executeBatchQuery(credential, batch, sessionKey) {
+    var _a;
     const length = batch.length;
     const result = new Array(length);
     const caching = length > 0 && this.hasCache(batch[0].service, sessionKey);
     const cacheValue = { value: this.valueOfKey(credential, 'cache'), sessionKey };
     let client;
-    const createClient = () => {
-        setDatabaseEndpoint(credential);
-        return client || (client = createDatabaseClient.call(this, length === 1 ? credential : { ...credential }));
-    };
+    const createClient = () => client || (client = createDatabaseClient.call(this, credential));
+    setDatabaseEndpoint(credential);
     for (let i = 0; i < length; ++i) {
         const item = batch[i];
-        const { service, table, id = '', query, partitionKey, key = partitionKey, limit = 0, update, ignoreCache } = item;
-        if (!table) {
-            throw (0, util_1.formatError)(item, "Missing database table" /* ERR_DB.TABLE */);
-        }
-        const renewCache = ignoreCache === 0;
+        let { service, table: TableName, id, query, partitionKey, key = partitionKey, limit = 0, update, ignoreCache } = item;
+        const useCache = caching && ignoreCache !== true;
         const getCache = (value) => {
             if (ignoreCache !== 1) {
-                cacheValue.renewCache = renewCache;
+                cacheValue.renewCache = ignoreCache === 0;
                 return this.getQueryResult(service, credential, value, cacheValue);
             }
         };
-        let rows, queryString = caching && ignoreCache !== true || ignoreCache === false || ignoreCache === 1 || renewCache ? table + '_' : '';
+        cacheValue.exclusiveOf = Array.isArray(ignoreCache) ? ignoreCache : undefined;
+        let rows, queryString = '';
         if (key && (id || (0, types_1.isPlainObject)(key))) {
-            if (queryString) {
-                queryString += Module.asString(key, true) + id;
+            if (!TableName) {
+                throw (0, util_1.formatError)(item, "Missing database table" /* ERR_DB.TABLE */);
+            }
+            if (useCache) {
+                queryString = TableName + '_' + Module.asString(key, true) + (id !== undefined ? '_' + Module.asString(id, true) : '');
                 if (!update && (rows = getCache(queryString))) {
                     result[i] = rows;
                     continue;
                 }
             }
-            const Key = (0, types_1.isPlainObject)(key) ? key : { [key]: id };
-            const command = { TableName: table, Key };
+            const Key = (0, types_1.isPlainObject)(key) ? key : { [key]: parseAttributeValue(id) };
+            const command = { TableName, Key };
             client = createClient();
             if (update) {
                 await client.update({ ...command, ...update }).promise();
@@ -327,19 +335,63 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             }
         }
         else if ((0, types_1.isPlainObject)(query)) {
-            if (queryString && (rows = getCache(queryString += Module.asString(query, true) + limit))) {
-                result[i] = rows;
-                continue;
+            if (TableName) {
+                query.TableName = TableName;
+            }
+            if (!TableName) {
+                throw (0, util_1.formatError)(item, "Missing database table" /* ERR_DB.TABLE */);
             }
-            query.TableName = table;
             if (limit > 0) {
                 query.Limit = limit;
             }
+            if (useCache && (rows = getCache(queryString = Module.asString(query, true)))) {
+                result[i] = rows;
+                continue;
+            }
             const { Count, Items } = await createClient().query(query).promise();
             if (Count && Items) {
                 rows = Items;
             }
         }
+        else if ((0, types_1.isArray)(query)) {
+            let params = (item.params || {});
+            if (!(0, types_1.isPlainObject)(params.RequestItems)) {
+                params.RequestItems = {};
+            }
+            TableName || (TableName = Object.keys(params.RequestItems)[0]);
+            if (!TableName) {
+                throw (0, util_1.formatError)(item, "Missing database table" /* ERR_DB.TABLE */);
+            }
+            // @ts-ignore
+            const Item = (_a = params.RequestItems)[TableName] || (_a[TableName] = {});
+            Item.Keys = query;
+            params = { RequestItems: { [TableName]: Item } };
+            if (useCache && (rows = getCache(queryString = Module.asString(params, true)))) {
+                result[i] = rows;
+                continue;
+            }
+            const { Responses } = await createClient().batchGet(params).promise();
+            if (Responses) {
+                rows = Responses[TableName];
+            }
+        }
+        else if (TableName) {
+            let params = item.params;
+            if ((0, types_1.isPlainObject)(params)) {
+                params.TableName = TableName;
+            }
+            else {
+                params = { TableName };
+            }
+            if (useCache && (rows = getCache(queryString = Module.asString(params, true)))) {
+                result[i] = rows;
+                continue;
+            }
+            const { Count, Items } = await createClient().scan(params).promise();
+            if (Count && Items) {
+                rows = Items;
+            }
+        }
         else {
             throw (0, util_1.formatError)(item, "Missing database query" /* ERR_DB.QUERY */);
         }
@@ -350,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;
         }
@@ -381,9 +433,39 @@ 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) {
+    switch (typeof value) {
+        case 'string':
+            return { S: value };
+        case 'number':
+            return { N: value.toString() };
+        case 'boolean':
+            return { BOOL: value };
+        case 'object':
+            if (value !== null) {
+                if ('S' in value || 'N' in value || 'BOOL' in value || 'B' in value || 'SS' in value || 'NS' in value || 'BS' in value || 'L' in value || 'M' in value || 'NULL' in value) {
+                    return value;
+                }
+                if (Buffer.isBuffer(value)) {
+                    return { B: value.toString('base64') };
+                }
+                if (Array.isArray(value)) {
+                    return value.every(item => typeof item === 'string') ? { SS: value } : value.every(item => typeof item === 'number') ? { NS: value.map((item) => item.toString()) } : value.every(item => Buffer.isBuffer(item)) ? { BS: value.map((item) => item.toString('base64')) } : { L: value.map(item => parseAttributeValue(item)) };
+                }
+                const M = {};
+                for (const attr in value) {
+                    M[attr] = parseAttributeValue(value[attr]);
+                }
+                return { M };
+            }
+            break;
+    }
+    return { NULL: true };
+}
+exports.parseAttributeValue = parseAttributeValue;
 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "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.8.0",
-    "@e-mc/module": "^0.8.0",
-    "@e-mc/types": "^0.8.0",
-    "aws-sdk": "^2.1524.0"
+    "@e-mc/cloud": "^0.8.2",
+    "@e-mc/module": "^0.8.2",
+    "@e-mc/types": "^0.8.2",
+    "aws-sdk": "^2.1545.0"
   }
 }

package/types/index.d.ts

@@ -3,7 +3,7 @@ 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 { BatchGetItemInput, Key, QueryInput, ScanInput, UpdateItemInput } 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";
@@ -15,7 +15,7 @@ export interface AWSStorageCredential extends ConfigurationOptions {
     fromPath?: string;
 }
 
-export interface AWSDatabaseQuery extends CloudDatabase<QueryInput, PlainObject, UpdateItemInput> {
+export interface AWSDatabaseQuery extends CloudDatabase<QueryInput | Key[], PlainObject, UpdateItemInput, BatchGetItemInput | ScanInput> {
     key?: string | Key;
     partitionKey?: string | Key;
 }

package/upload/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
-const fs = require("fs");
 const util_1 = require("@e-mc/cloud/util");
 const types_1 = require("@e-mc/types");
 const Module = require("@e-mc/module");
@@ -37,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 => {
@@ -81,15 +80,10 @@ function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
         const Body = [data.buffer];
         const ContentType = [contentType];
         if (fileGroup) {
-            for (const [content, ext, localFile] of fileGroup) {
-                try {
-                    Body.push(typeof content === 'string' ? fs.readFileSync(content) : content);
-                    Key.push(ext === '.map' && localFile ? path.basename(localFile) : filename + ext);
-                }
-                catch (err) {
-                    addLog(err);
-                }
-            }
+            const [key, body, type] = (0, util_1.createKeyAndBody)(filename, fileGroup, addLog);
+            Key.push(...key);
+            Body.push(...body);
+            ContentType.push(...type);
         }
         for (let i = 0; i < Key.length; ++i) {
             const first = i === 0;
@@ -125,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);
             });
         }
     };