@aws-sdk/lib-storage 3.85.0 → 3.86.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.86.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.85.0...v3.86.0) (2022-05-06)
+
+
+### Bug Fixes
+
+* **lib-storage:** add missing return keys ([#2700](https://github.com/aws/aws-sdk-js-v3/issues/2700)) ([cbab94e](https://github.com/aws/aws-sdk-js-v3/commit/cbab94e901aec4650ab9e0eb19a4515e44d4ba62))
+
+
+
+
+
 # [3.85.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.84.0...v3.85.0) (2022-05-05)
 
 **Note:** Version bump only for package @aws-sdk/lib-storage

package/README.md

@@ -8,26 +8,28 @@
 Upload allows for easy and efficient uploading of buffers, blobs, or streams, using a configurable amount of concurrency to perform multipart uploads where possible. This abstraction enables uploading large files or streams of unknown size due to the use of multipart uploads under the hood.
 
 ```js
-  import { Upload } from "@aws-sdk/lib-storage";
-  import { S3Client, S3 } from "@aws-sdk/client-s3";
-
-  const target = { Bucket, Key, Body };
-  try {
-    const parallelUploads3 = new Upload({
-      client: new S3({}) || new S3Client({}),
-      tags: [...], // optional tags
-      queueSize: 4, // optional concurrency configuration
-      partSize: 5MB, // optional size of each part
-      leavePartsOnError: false, // optional manually handle dropped parts
-      params: target,
-    });
-
-    parallelUploads3.on("httpUploadProgress", (progress) => {
-      console.log(progress);
-    });
-
-    await parallelUploads3.done();
-  } catch (e) {
-    console.log(e);
-  }
+import { Upload } from "@aws-sdk/lib-storage";
+import { S3Client, S3 } from "@aws-sdk/client-s3";
+
+try {
+  const parallelUploads3 = new Upload({
+    client: new S3({}) || new S3Client({}),
+    params: { Bucket, Key, Body },
+
+    tags: [
+      /*...*/
+    ], // optional tags
+    queueSize: 4, // optional concurrency configuration
+    partSize: 1024 * 1024 * 5, // optional size of each part, in bytes, at least 5MB
+    leavePartsOnError: false, // optional manually handle dropped parts
+  });
+
+  parallelUploads3.on("httpUploadProgress", (progress) => {
+    console.log(progress);
+  });
+
+  await parallelUploads3.done();
+} catch (e) {
+  console.log(e);
+}
 ```

package/dist-cjs/Upload.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Upload = void 0;
 const abort_controller_1 = require("@aws-sdk/abort-controller");
 const client_s3_1 = require("@aws-sdk/client-s3");
+const smithy_client_1 = require("@aws-sdk/smithy-client");
 const events_1 = require("events");
 const bytelength_1 = require("./bytelength");
 const chunker_1 = require("./chunker");
@@ -37,13 +38,29 @@ class Upload extends events_1.EventEmitter {
     }
     on(event, listener) {
         this.uploadEvent = event;
-        super.on(event, listener);
+        return super.on(event, listener);
     }
     async __uploadUsingPut(dataPart) {
         this.isMultiPart = false;
         const params = { ...this.params, Body: dataPart.data };
-        const putResult = await this.client.send(new client_s3_1.PutObjectCommand(params));
-        this.putResponse = putResult;
+        const [putResult, endpoint] = await Promise.all([
+            this.client.send(new client_s3_1.PutObjectCommand(params)),
+            this.client.config.endpoint(),
+        ]);
+        const locationKey = this.params
+            .Key.split("/")
+            .map((segment) => (0, smithy_client_1.extendedEncodeURIComponent)(segment))
+            .join("/");
+        const locationBucket = (0, smithy_client_1.extendedEncodeURIComponent)(this.params.Bucket);
+        const Location = this.client.config.forcePathStyle
+            ? `${endpoint.protocol}//${endpoint.hostname}/${locationBucket}/${locationKey}`
+            : `${endpoint.protocol}//${locationBucket}.${endpoint.hostname}/${locationKey}`;
+        this.singleUploadResult = {
+            ...putResult,
+            Bucket: this.params.Bucket,
+            Key: this.params.Key,
+            Location,
+        };
         const totalSize = (0, bytelength_1.byteLength)(dataPart.data);
         this.__notifyProgress({
             loaded: totalSize,
@@ -139,7 +156,7 @@ class Upload extends events_1.EventEmitter {
             result = await this.client.send(new client_s3_1.CompleteMultipartUploadCommand(uploadCompleteParams));
         }
         else {
-            result = this.putResponse;
+            result = this.singleUploadResult;
         }
         if (this.tags.length) {
             await this.client.send(new client_s3_1.PutObjectTaggingCommand({

package/dist-es/Upload.js

@@ -1,6 +1,7 @@
-import { __assign, __asyncValues, __awaiter, __extends, __generator } from "tslib";
+import { __assign, __asyncValues, __awaiter, __extends, __generator, __read } from "tslib";
 import { AbortController } from "@aws-sdk/abort-controller";
 import { CompleteMultipartUploadCommand, CreateMultipartUploadCommand, PutObjectCommand, PutObjectTaggingCommand, UploadPartCommand, } from "@aws-sdk/client-s3";
+import { extendedEncodeURIComponent } from "@aws-sdk/smithy-client";
 import { EventEmitter } from "events";
 import { byteLength } from "./bytelength";
 import { getChunk } from "./chunker";
@@ -49,20 +50,31 @@ var Upload = (function (_super) {
     };
     Upload.prototype.on = function (event, listener) {
         this.uploadEvent = event;
-        _super.prototype.on.call(this, event, listener);
+        return _super.prototype.on.call(this, event, listener);
     };
     Upload.prototype.__uploadUsingPut = function (dataPart) {
         return __awaiter(this, void 0, void 0, function () {
-            var params, putResult, totalSize;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var params, _a, putResult, endpoint, locationKey, locationBucket, Location, totalSize;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         this.isMultiPart = false;
                         params = __assign(__assign({}, this.params), { Body: dataPart.data });
-                        return [4, this.client.send(new PutObjectCommand(params))];
+                        return [4, Promise.all([
+                                this.client.send(new PutObjectCommand(params)),
+                                this.client.config.endpoint(),
+                            ])];
                     case 1:
-                        putResult = _a.sent();
-                        this.putResponse = putResult;
+                        _a = __read.apply(void 0, [_b.sent(), 2]), putResult = _a[0], endpoint = _a[1];
+                        locationKey = this.params
+                            .Key.split("/")
+                            .map(function (segment) { return extendedEncodeURIComponent(segment); })
+                            .join("/");
+                        locationBucket = extendedEncodeURIComponent(this.params.Bucket);
+                        Location = this.client.config.forcePathStyle
+                            ? "".concat(endpoint.protocol, "//").concat(endpoint.hostname, "/").concat(locationBucket, "/").concat(locationKey)
+                            : "".concat(endpoint.protocol, "//").concat(locationBucket, ".").concat(endpoint.hostname, "/").concat(locationKey);
+                        this.singleUploadResult = __assign(__assign({}, putResult), { Bucket: this.params.Bucket, Key: this.params.Key, Location: Location });
                         totalSize = byteLength(dataPart.data);
                         this.__notifyProgress({
                             loaded: totalSize,
@@ -206,7 +218,7 @@ var Upload = (function (_super) {
                         result = _a.sent();
                         return [3, 4];
                     case 3:
-                        result = this.putResponse;
+                        result = this.singleUploadResult;
                         _a.label = 4;
                     case 4:
                         if (!this.tags.length) return [3, 6];

package/dist-types/Upload.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
-import { AbortSignal } from "@aws-sdk/abort-controller";
-import { ServiceOutputTypes } from "@aws-sdk/client-s3";
+import { AbortMultipartUploadCommandOutput, CompleteMultipartUploadCommandOutput } from "@aws-sdk/client-s3";
 import { EventEmitter } from "events";
 import { BodyDataTypes, Options, Progress } from "./types";
 export interface RawDataPart {
@@ -28,16 +27,16 @@ export declare class Upload extends EventEmitter {
     private uploadId?;
     uploadEvent?: string;
     private isMultiPart;
-    private putResponse?;
+    private singleUploadResult?;
     constructor(options: Options);
     abort(): Promise<void>;
-    done(): Promise<ServiceOutputTypes>;
-    on(event: "httpUploadProgress", listener: (progress: Progress) => void): any;
-    __uploadUsingPut(dataPart: RawDataPart): Promise<void>;
-    __createMultipartUpload(): Promise<void>;
-    __doConcurrentUpload(dataFeeder: AsyncGenerator<RawDataPart, void, undefined>): Promise<void>;
-    __doMultipartUpload(): Promise<ServiceOutputTypes>;
-    __notifyProgress(progress: Progress): void;
-    __abortTimeout(abortSignal: AbortSignal): Promise<ServiceOutputTypes>;
-    __validateInput(): void;
+    done(): Promise<CompleteMultipartUploadCommandOutput | AbortMultipartUploadCommandOutput>;
+    on(event: "httpUploadProgress", listener: (progress: Progress) => void): this;
+    private __uploadUsingPut;
+    private __createMultipartUpload;
+    private __doConcurrentUpload;
+    private __doMultipartUpload;
+    private __notifyProgress;
+    private __abortTimeout;
+    private __validateInput;
 }

package/dist-types/ts3.4/Upload.d.ts

@@ -1,6 +1,5 @@
 
-import { AbortSignal } from "@aws-sdk/abort-controller";
-import { ServiceOutputTypes } from "@aws-sdk/client-s3";
+import { AbortMultipartUploadCommandOutput, CompleteMultipartUploadCommandOutput } from "@aws-sdk/client-s3";
 import { EventEmitter } from "events";
 import { BodyDataTypes, Options, Progress } from "./types";
 export interface RawDataPart {
@@ -26,16 +25,16 @@ export declare class Upload extends EventEmitter {
     private uploadId?;
     uploadEvent?: string;
     private isMultiPart;
-    private putResponse?;
+    private singleUploadResult?;
     constructor(options: Options);
     abort(): Promise<void>;
-    done(): Promise<ServiceOutputTypes>;
-    on(event: "httpUploadProgress", listener: (progress: Progress) => void): any;
-    __uploadUsingPut(dataPart: RawDataPart): Promise<void>;
-    __createMultipartUpload(): Promise<void>;
-    __doConcurrentUpload(dataFeeder: AsyncGenerator<RawDataPart, void, undefined>): Promise<void>;
-    __doMultipartUpload(): Promise<ServiceOutputTypes>;
-    __notifyProgress(progress: Progress): void;
-    __abortTimeout(abortSignal: AbortSignal): Promise<ServiceOutputTypes>;
-    __validateInput(): void;
+    done(): Promise<CompleteMultipartUploadCommandOutput | AbortMultipartUploadCommandOutput>;
+    on(event: "httpUploadProgress", listener: (progress: Progress) => void): this;
+    private __uploadUsingPut;
+    private __createMultipartUpload;
+    private __doConcurrentUpload;
+    private __doMultipartUpload;
+    private __notifyProgress;
+    private __abortTimeout;
+    private __validateInput;
 }

package/dist-types/ts3.4/types.d.ts

@@ -7,6 +7,7 @@ export interface Progress {
     Bucket?: string;
 }
 export declare type BodyDataTypes = PutObjectCommandInput["Body"];
+
 export declare type ServiceClients = S3Client;
 export interface Configuration {
     
@@ -22,5 +23,5 @@ export interface Options extends Partial<Configuration> {
     
     params: PutObjectCommandInput;
     
-    client: ServiceClients;
+    client: S3Client;
 }

package/dist-types/types.d.ts

@@ -7,6 +7,9 @@ export interface Progress {
     Bucket?: string;
 }
 export declare type BodyDataTypes = PutObjectCommandInput["Body"];
+/**
+ * @deprecated redundant, use {@link S3Client} directly.
+ */
 export declare type ServiceClients = S3Client;
 export interface Configuration {
     /**
@@ -39,5 +42,5 @@ export interface Options extends Partial<Configuration> {
      * A service client.
      * This the target where we upload data.
      */
-    client: ServiceClients;
+    client: S3Client;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/lib-storage",
-  "version": "3.85.0",
+  "version": "3.86.0",
   "description": "Storage higher order operation",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -34,7 +34,7 @@
   },
   "devDependencies": {
     "@aws-sdk/abort-controller": "3.78.0",
-    "@aws-sdk/client-s3": "3.85.0",
+    "@aws-sdk/client-s3": "3.86.0",
     "@tsconfig/recommended": "1.0.1",
     "@types/node": "^14.11.2",
     "concurrently": "7.0.0",