@pi-r/aws 0.8.3 → 0.9.0

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.
-
-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.
+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.
+
+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

@@ -4,4 +4,4 @@ https://e-mc.readthedocs.io/en/latest/cloud/aws.html
 
 ### LICENSE
 
-MIT
+MIT

package/client/index.d.ts

@@ -1,5 +1,5 @@
 import type { ICloud, IModule } from '@e-mc/types/lib';
-import type { BucketWebsiteOptions, CloudDatabase } from '@e-mc/types/lib/cloud';
+import type { BucketWebsiteOptions, CloudDatabase, RecursiveAction } from '@e-mc/types/lib/cloud';
 import type { BatchQueryResult, QueryResult } from '@e-mc/types/lib/db';
 
 import type { BucketCannedACL } from '@pi-r/aws-lib';
@@ -7,9 +7,11 @@ import type { BucketCannedACL } from '@pi-r/aws-lib';
 import type { AWSDatabaseCredential, AWSDatabaseQuery, AWSStorageCredential, ConfigureBucketOptions } from '../types';
 
 import type { AttributeValue, DocumentClient } from 'aws-sdk/clients/dynamodb';
-import type { CreateBucketRequest } from 'aws-sdk/clients/s3';
+import type { CreateBucketRequest, ListObjectsRequest as IListObjectsRequest } from 'aws-sdk/clients/s3';
 
 declare namespace AWS {
+    type ListObjectsRequest = IListObjectsRequest & RecursiveAction;
+
     function validateStorage(credential: AWSStorageCredential): boolean;
     function validateDatabase(credential: AWSDatabaseCredential, data: CloudDatabase): boolean;
     function createStorageClient(this: IModule, credential: AWSStorageCredential, service?: string, sdk?: string): boolean;
@@ -20,6 +22,7 @@ declare namespace AWS {
     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 deleteObjectsV3(this: IModule, credential: AWSStorageCredential, Bucket: string, options?: ListObjectsRequest, 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 parseAttributeValue(value: unknown): AttributeValue;

package/client/index.js

@@ -11,14 +11,15 @@ exports.setBucketTagging = setBucketTagging;
 exports.setBucketWebsite = setBucketWebsite;
 exports.deleteObjects = deleteObjects;
 exports.deleteObjectsV2 = deleteObjectsV2;
+exports.deleteObjectsV3 = deleteObjectsV3;
 exports.executeQuery = executeQuery;
 exports.executeBatchQuery = executeBatchQuery;
 exports.parseAttributeValue = parseAttributeValue;
 exports.isNoSuchBucket = isNoSuchBucket;
 const aws = require("aws-sdk");
 const Cloud = require("@e-mc/cloud");
-const util_1 = require("@e-mc/cloud/util");
 const types_1 = require("@e-mc/types");
+const util_1 = require("@e-mc/cloud/util");
 const aws_lib_1 = require("@pi-r/aws-lib");
 const ACP_AUTHENTICATEDREAD = {
     Grants: [
@@ -127,7 +128,7 @@ function createDatabaseClient(credential) {
     }
     return new aws.DynamoDB.DocumentClient(options);
 }
-async function createBucket(credential, Bucket, publicRead, service = "aws", sdk = "aws-sdk/clients/s3") {
+async function createBucket(credential, Bucket, publicRead, service, sdk) {
     return createBucketV2.call(this, credential, Bucket, publicRead ? "public-read" : undefined, undefined, service, sdk);
 }
 async function createBucketV2(credential, Bucket, ACL, options, service = "aws", sdk = "aws-sdk/clients/s3") {
@@ -209,7 +210,7 @@ async function setBucketTagging(credential, Bucket, options, service = "aws", sd
         return S3.deleteBucketTagging({ Bucket, ExpectedBucketOwner: options.ExpectedBucketOwner }).promise().then(command).catch((err) => error(err));
     }
     options.Bucket = Bucket;
-    return S3.putBucketTagging(options).promise().then(command).catch((err) => error(err));
+    return S3.putBucketTagging(options).promise().then(command).catch(error);
 }
 async function setBucketWebsite(credential, Bucket, options, service = "aws", sdk = "aws-sdk/clients/s3") {
     const S3 = createStorageClient.call(this, credential, service, sdk);
@@ -233,12 +234,22 @@ async function setBucketWebsite(credential, Bucket, options, service = "aws", sd
         return false;
     });
 }
-async function deleteObjects(credential, Bucket, service = "aws", sdk = "aws-sdk/clients/s3") {
-    return deleteObjectsV2.call(this, credential, Bucket, true, service, sdk);
+async function deleteObjects(credential, Bucket, service, sdk, recursive = true) {
+    return deleteObjectsV2.call(this, credential, Bucket, recursive, service, sdk);
 }
-async function deleteObjectsV2(credential, Bucket, recursive = true, service = "aws", sdk = "aws-sdk/clients/s3") {
+async function deleteObjectsV2(credential, Bucket, recursive = true, service, sdk) {
+    return deleteObjectsV3.call(this, credential, Bucket, { recursive, Bucket }, service, sdk);
+}
+async function deleteObjectsV3(credential, Bucket, options = {}, service = "aws", sdk = "aws-sdk/clients/s3") {
+    options = { ...options };
+    let recursive = true;
+    if ('recursive' in options) {
+        recursive = options.recursive;
+        delete options.recursive;
+    }
+    options.Bucket ||= Bucket;
     const S3 = createStorageClient.call(this, credential, service, sdk);
-    return S3.listObjects({ Bucket }).promise()
+    return S3.listObjects(options).promise()
         .then(async ({ Contents }) => {
         if (Contents?.length) {
             let Objects = Contents.map(data => ({ Key: data.Key }));

package/download/index.js

@@ -1,6 +1,6 @@
 "use strict";
-const types_1 = require("@e-mc/types");
 const Cloud = require("@e-mc/cloud");
+const types_1 = require("@e-mc/types");
 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "AWS V2 cloud functions for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -14,17 +14,16 @@
   },
   "keywords": [
     "squared",
-    "e-mc",
-    "squared-functions"
+    "e-mc"
   ],
   "author": "An Pham <anpham6@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/cloud": "^0.10.3",
-    "@e-mc/module": "^0.10.3",
-    "@e-mc/types": "^0.10.3",
-    "@pi-r/aws-lib": "^0.8.3",
-    "aws-sdk": "^2.1691.0"
+    "@e-mc/cloud": "^0.11.0",
+    "@e-mc/module": "^0.11.0",
+    "@e-mc/types": "^0.11.0",
+    "@pi-r/aws-lib": "^0.9.0",
+    "aws-sdk": "^2.1692.0"
   }
 }

package/types/index.d.ts

@@ -1,29 +1,29 @@
-import type { CloudDatabase, CloudStorage } from '@e-mc/types/lib/cloud';
-
-import type { ConfigurationOptions } from 'aws-sdk/lib/core';
-import type { DocumentClient, Types } from 'aws-sdk/clients/dynamodb';
-import type { PutBucketAclRequest, PutBucketPolicyRequest, PutPublicAccessBlockRequest } from 'aws-sdk/clients/s3';
-
-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 type DynamoDBClientConfig = Types.ClientConfiguration & DocumentClient.DocumentClientOptions;
-
-export type AWSStorage = CloudStorage<AWSStorageCredential, "aws">;
-
-export interface AWSStorageCredential extends ConfigurationOptions {
-    profile?: string;
-    fromPath?: string;
-}
-
-export interface AWSDatabaseQuery extends CloudDatabase<QueryInput | Key[], Record<string, unknown>, UpdateItemInput, BatchGetItemInput | ScanInput, AWSDatabaseCredential> {
-    source: "cloud";
-    service: "aws";
-    key?: string | Key;
-}
-
+import type { CloudDatabase, CloudStorage } from '@e-mc/types/lib/cloud';
+
+import type { ConfigurationOptions } from 'aws-sdk/lib/core';
+import type { DocumentClient, Types } from 'aws-sdk/clients/dynamodb';
+import type { PutBucketAclRequest, PutBucketPolicyRequest, PutPublicAccessBlockRequest } from 'aws-sdk/clients/s3';
+
+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 type DynamoDBClientConfig = Types.ClientConfiguration & DocumentClient.DocumentClientOptions;
+
+export type AWSStorage = CloudStorage<AWSStorageCredential, "aws">;
+
+export interface AWSStorageCredential extends ConfigurationOptions {
+    profile?: string;
+    fromPath?: string;
+}
+
+export interface AWSDatabaseQuery extends CloudDatabase<QueryInput | Key[], Record<string, unknown>, UpdateItemInput, BatchGetItemInput | ScanInput, AWSDatabaseCredential> {
+    source: "cloud";
+    service: "aws";
+    key?: string | Key;
+}
+
 export interface AWSDatabaseCredential extends AWSStorageCredential, DynamoDBClientConfig {}

package/upload/index.js

@@ -1,12 +1,12 @@
 "use strict";
-const path = require("path");
-const fs = require("fs");
-const stream = require("stream");
+const path = require("node:path");
+const fs = require("node:fs");
+const stream = require("node:stream");
 const aws = require("aws-sdk");
-const crypto_1 = require("crypto");
+const node_crypto_1 = require("node:crypto");
 const Cloud = require("@e-mc/cloud");
-const util_1 = require("@e-mc/cloud/util");
 const types_1 = require("@e-mc/types");
+const util_1 = require("@e-mc/cloud/util");
 const aws_lib_1 = require("@pi-r/aws-lib");
 const client_1 = require("@pi-r/aws");
 const BUCKET_SESSION = new Set();
@@ -108,7 +108,7 @@ function upload(credential, service = "aws", sdk = "aws-sdk/clients/s3") {
         if (!overwrite) {
             const current = filename;
             const next = (0, util_1.generateFilename)(filename);
-            let i = 0, exists;
+            let i = 0, exists = false;
             do {
                 if (i > 0) {
                     [filename, exists] = next(i);
@@ -120,7 +120,7 @@ function upload(credential, service = "aws", sdk = "aws-sdk/clients/s3") {
                     .then(() => true)
                     .catch((err) => {
                     if (err instanceof Error && err.code !== 'NotFound') {
-                        filename = (0, crypto_1.randomUUID)() + path.extname(current);
+                        filename = (0, node_crypto_1.randomUUID)() + path.extname(current);
                     }
                     return false;
                 });