@pi-r/aws 0.3.5 → 0.3.6

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2023 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,5 @@
-# @pi-r/aws
-
-PEP 402 - Forever
-
-## LICENSE
-
+# @pi-r/aws
+
+## LICENSE
+
 MIT

package/client/index.d.ts

@@ -1,38 +1,38 @@
-import type { ICloud, IModule } from '@e-mc/types/lib';
-import type { BucketWebsiteOptions, CloudDatabase } from '@e-mc/types/lib/cloud';
-import type { BatchQueryResult, QueryResult } from '@e-mc/types/lib/db';
-
-import type { AWSDatabaseCredential, AWSDatabaseQuery, AWSStorageCredential, BucketCannedACL, ConfigureBucketOptions } from '../types';
-
-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 { 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 isDatabaseDefined(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
-    function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
-    function getBucketPublicReadPolicy(bucket: string): string;
-    function getPrivatePolicy(bucket: string): string;
-    function validateStorage(credential: AWSStorageCredential): boolean;
-    function validateDatabase(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
-    function createStorageClient(this: IModule, credential: AWSStorageCredential, service?: string, sdk?: string): boolean;
-    function createDatabaseClient(this: IModule, credential: AWSDatabaseCredential): DocumentClient;
-    function createBucket(this: IModule, credential: AWSStorageCredential, Bucket: string, publicRead?: boolean, service?: string, sdk?: string): Promise<boolean>;
-    function createBucketV2(this: IModule, credential: AWSStorageCredential, Bucket: string, ACL?: BucketCannedACL | 1, options?: CreateBucketRequest, service?: string, sdk?: string): Promise<boolean>;
-    function setBucketPolicy(this: IModule, credential: AWSStorageCredential, Bucket: string, options: ConfigureBucketOptions, service?: string, sdk?: string): Promise<boolean>;
-    function setBucketWebsite(this: IModule, credential: AWSStorageCredential, Bucket: string, options: BucketWebsiteOptions, service?: string, sdk?: string): Promise<boolean>;
-    function deleteObjects(this: IModule, credential: AWSStorageCredential, Bucket: string, service?: string, sdk?: string): Promise<void>;
-    function deleteObjectsV2(this: IModule, credential: AWSStorageCredential, Bucket: string, recursive?: boolean, service?: string, sdk?: string): Promise<void>;
-    function executeQuery(this: ICloud, credential: AWSDatabaseCredential, data: AWSDatabaseQuery, sessionKey?: string): Promise<QueryResult>;
-    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 getBucketKey(credential: unknown, Bucket: string, acl: string | undefined, service: string, sdk: string): string;
-    function isNoSuchBucket(err: unknown): boolean;
-}
-
+import type { ICloud, IModule } from '@e-mc/types/lib';
+import type { BucketWebsiteOptions, CloudDatabase } from '@e-mc/types/lib/cloud';
+import type { BatchQueryResult, QueryResult } from '@e-mc/types/lib/db';
+
+import type { AWSDatabaseCredential, AWSDatabaseQuery, AWSStorageCredential, BucketCannedACL, ConfigureBucketOptions } from '../types';
+
+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 { 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 isDatabaseDefined(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
+    function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
+    function getBucketPublicReadPolicy(bucket: string): string;
+    function getPrivatePolicy(bucket: string): string;
+    function validateStorage(credential: AWSStorageCredential): boolean;
+    function validateDatabase(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
+    function createStorageClient(this: IModule, credential: AWSStorageCredential, service?: string, sdk?: string): boolean;
+    function createDatabaseClient(this: IModule, credential: AWSDatabaseCredential): DocumentClient;
+    function createBucket(this: IModule, credential: AWSStorageCredential, Bucket: string, publicRead?: boolean, service?: string, sdk?: string): Promise<boolean>;
+    function createBucketV2(this: IModule, credential: AWSStorageCredential, Bucket: string, ACL?: BucketCannedACL | 1, options?: CreateBucketRequest, service?: string, sdk?: string): Promise<boolean>;
+    function setBucketPolicy(this: IModule, credential: AWSStorageCredential, Bucket: string, options: ConfigureBucketOptions, service?: string, sdk?: string): Promise<boolean>;
+    function setBucketWebsite(this: IModule, credential: AWSStorageCredential, Bucket: string, options: BucketWebsiteOptions, service?: string, sdk?: string): Promise<boolean>;
+    function deleteObjects(this: IModule, credential: AWSStorageCredential, Bucket: string, service?: string, sdk?: string): Promise<void>;
+    function deleteObjectsV2(this: IModule, credential: AWSStorageCredential, Bucket: string, recursive?: boolean, service?: string, sdk?: string): Promise<void>;
+    function executeQuery(this: ICloud, credential: AWSDatabaseCredential, data: AWSDatabaseQuery, sessionKey?: string): Promise<QueryResult>;
+    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 getBucketKey(credential: unknown, Bucket: string, acl: string | undefined, service: string, sdk: string): string;
+    function isNoSuchBucket(err: unknown): boolean;
+}
+
 export = AWS;

package/client/index.js

@@ -1,7 +1,6 @@
 "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;
-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");
@@ -124,18 +123,20 @@ exports.validateDatabase = validateDatabase;
 function createStorageClient(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {
     try {
         if (service === 'aws') {
-            const { profile, fromPath } = credential;
-            if (fromPath) {
-                const client = new aws.S3();
-                client.config.loadFromPath(fromPath);
+            const S3 = require('aws-sdk/clients/s3');
+            if (credential.fromPath) {
+                const client = new S3();
+                client.config.loadFromPath(credential.fromPath);
                 return client;
             }
-            if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
-                credential = new aws.SharedIniFileCredentials({ profile });
+            if (credential.profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
+                const { SharedIniFileCredentials } = require('aws-sdk');
+                credential = new SharedIniFileCredentials({ profile: credential.profile });
             }
-            return new aws.S3(credential);
+            return new S3(credential);
         }
-        return new (require(sdk))(credential);
+        const S3 = require(sdk);
+        return new S3(credential);
     }
     catch (err) {
         this.checkPackage(err, sdk.split('/')[0], { passThrough: true });
@@ -144,18 +145,26 @@ function createStorageClient(credential, service = 'aws', sdk = 'aws-sdk/clients
 }
 exports.createStorageClient = createStorageClient;
 function createDatabaseClient(credential) {
-    const { profile, fromPath } = credential;
-    let options;
-    if (fromPath) {
-        aws.config.loadFromPath(fromPath);
-    }
-    else if (profile || process.env.AWS_SDK_LOAD_CONFIG === '1' && !isAccessDefined(credential) && !isEnvDefined()) {
-        options = new aws.SharedIniFileCredentials({ profile });
+    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);
     }
-    else {
-        options = credential;
+    catch (err) {
+        this.checkPackage(err, 'aws-sdk', { passThrough: true });
+        throw err;
     }
-    return new aws.DynamoDB.DocumentClient(options);
 }
 exports.createDatabaseClient = createDatabaseClient;
 function createBucket(credential, Bucket, publicRead, service = 'aws', sdk = 'aws-sdk/clients/s3') {
@@ -175,8 +184,8 @@ function createBucketV2(credential, Bucket, ACL, options, service = 'aws', sdk =
         .catch(() => {
         const input = { ...options, Bucket };
         const region = credential.region;
-        if (region && (region !== 'us-east-1' || service !== 'aws')) {
-            input.CreateBucketConfiguration || (input.CreateBucketConfiguration = { LocationConstraint: region });
+        if (!input.CreateBucketConfiguration && typeof region === 'string' && (region !== 'us-east-1' || service !== 'aws')) {
+            input.CreateBucketConfiguration = { LocationConstraint: region };
         }
         return S3.createBucket(input).promise()
             .then(async () => {
@@ -226,12 +235,11 @@ 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 = {};
-    const { indexPage: Suffix, errorPage: Key } = options;
-    if ((0, types_1.isString)(Suffix)) {
-        WebsiteConfiguration.IndexDocument = { Suffix };
+    if ((0, types_1.isString)(options.indexPage)) {
+        WebsiteConfiguration.IndexDocument = { Suffix: options.indexPage };
     }
-    if ((0, types_1.isString)(Key)) {
-        WebsiteConfiguration.ErrorDocument = { Key };
+    if ((0, types_1.isString)(options.errorPage)) {
+        WebsiteConfiguration.ErrorDocument = { Key: options.errorPage };
     }
     return S3.putBucketWebsite({ Bucket, WebsiteConfiguration }).promise()
         .then(() => {
@@ -261,9 +269,8 @@ async function deleteObjectsV2(credential, Bucket, recursive = true, service = '
             }
             return S3.deleteObjects({ Bucket, Delete: { Objects } }).promise()
                 .then(data => {
-                const Deleted = data.Deleted;
-                if ((0, types_1.isArray)(Deleted)) {
-                    const files = Deleted.length + ' files';
+                if ((0, types_1.isArray)(data.Deleted)) {
+                    const files = data.Deleted.length + ' files';
                     this.formatMessage(64, service, ["Bucket emptied" + ` (${recursive ? 'recursive' : files})`, Bucket], recursive ? files : '', { ...Cloud.LOG_CLOUD_COMMAND });
                 }
             })
@@ -322,9 +329,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             if (update) {
                 await client.update({ ...command, ...update }).promise();
             }
-            const Item = (await client.get(command).promise()).Item;
-            if (Item) {
-                rows = [Item];
+            const output = await client.get(command).promise();
+            if (output.Item) {
+                rows = [output.Item];
             }
         }
         else if ((0, types_1.isPlainObject)(query)) {
@@ -336,9 +343,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
             if (limit > 0) {
                 query.Limit = limit;
             }
-            const { Count, Items } = await createClient().query(query).promise();
-            if (Count && Items) {
-                rows = Items;
+            const output = await createClient().query(query).promise();
+            if (output.Count && output.Items) {
+                rows = output.Items;
             }
         }
         else {
@@ -351,10 +358,9 @@ async function executeBatchQuery(credential, batch, sessionKey) {
 exports.executeBatchQuery = executeBatchQuery;
 function setDatabaseEndpoint(config) {
     var _a, _b;
-    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 = (_b = (((_a = /dynamodb\.([^.]+)\./i.exec(config.endpoint)) === null || _a === void 0 ? void 0 : _a[1]) || process.env.AWS_DEFAULT_REGION)) === null || _b === void 0 ? void 0 : _b.toLowerCase();
+    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 = (_b = (((_a = /dynamodb\.([^.]+)\./i.exec(config.endpoint)) === null || _a === void 0 ? void 0 : _a[1]) || process.env.AWS_DEFAULT_REGION)) === null || _b === void 0 ? void 0 : _b.toLowerCase();
         if (region && region !== 'us-east-1') {
             config.region = region;
         }

package/download/index.js

@@ -1,8 +1,8 @@
 "use strict";
+const client_1 = require("@pi-r/aws");
 const types_1 = require("@e-mc/types");
 const Module = require("@e-mc/module");
 const Cloud = require("@e-mc/cloud");
-const client_1 = require("@pi-r/aws");
 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,29 +1,29 @@
-{
-  "name": "@pi-r/aws",
-  "version": "0.3.5",
-  "description": "AWS V2 cloud functions for E-mc.",
-  "main": "client/index.js",
-  "types": "client/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/pi-r.git",
-    "directory": "src/cloud/aws"
-  },
-  "keywords": [
-    "squared",
-    "e-mc",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/pi-r#readme",
-  "dependencies": {
-    "@e-mc/cloud": "^0.6.7",
-    "@e-mc/module": "^0.6.7",
-    "@e-mc/types": "^0.6.7",
-    "aws-sdk": "^2.1659.0"
-  }
-}
+{
+  "name": "@pi-r/aws",
+  "version": "0.3.6",
+  "description": "AWS V2 cloud functions for E-mc.",
+  "main": "client/index.js",
+  "types": "client/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
+    "directory": "src/cloud/aws"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/cloud": "^0.6.16",
+    "@e-mc/module": "^0.6.16",
+    "@e-mc/types": "^0.6.16",
+    "aws-sdk": "^2.1659.0"
+  }
+}

package/types/index.d.ts

@@ -1,23 +1,23 @@
-
-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, 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 interface AWSStorageCredential extends ConfigurationOptions {
-    profile?: string;
-    fromPath?: string;
-}
-
-export interface AWSDatabaseQuery extends CloudDatabase<QueryInput, PlainObject, UpdateItemInput> {
-    key?: string | Key;
-    partitionKey?: string | Key;
-}
-
-export interface AWSDatabaseCredential extends AWSStorageCredential, ServiceConfigurationOptions {}
+
+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, 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 interface AWSStorageCredential extends ConfigurationOptions {
+    profile?: string;
+    fromPath?: string;
+}
+
+export interface AWSDatabaseQuery extends CloudDatabase<QueryInput, PlainObject, UpdateItemInput> {
+    key?: string | Key;
+    partitionKey?: string | Key;
+}
+
+export interface AWSDatabaseCredential extends AWSStorageCredential, ServiceConfigurationOptions {}

package/upload/index.js

@@ -1,11 +1,11 @@
 "use strict";
 const path = require("path");
 const fs = require("fs");
+const client_1 = require("@pi-r/aws");
 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("@pi-r/aws");
 const BUCKET_SESSION = new Set();
 const BUCKET_RESPONSE = {};
 function upload(credential, service = 'aws', sdk = 'aws-sdk/clients/s3') {