@aws-amplify/storage 5.6.3 → 5.6.4-api-v6.13

package/lib/AwsClients/S3/utils/serializeHelpers.js

@@ -0,0 +1,183 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializePathnameObjectKey = exports.serializeObjectConfigsToHeaders = exports.serializeObjectSsecOptionsToHeaders = exports.assignStringVariables = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var md5_js_1 = require("@aws-sdk/md5-js");
+var aws_client_utils_1 = require("@aws-amplify/core/internals/aws-client-utils");
+var utils_1 = require("../utils");
+/**
+ * @internal
+ */
+var assignStringVariables = function (values) {
+    var e_1, _a;
+    var queryParams = {};
+    try {
+        for (var _b = __values(Object.entries(values)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
+            if (value != null) {
+                queryParams[key] = value.toString();
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return queryParams;
+};
+exports.assignStringVariables = assignStringVariables;
+var serializeObjectSsecOptionsToHeaders = function (input) { return __awaiter(void 0, void 0, void 0, function () {
+    var getMd5Digest, _a, _b, _c, _d;
+    var _e;
+    return __generator(this, function (_f) {
+        switch (_f.label) {
+            case 0:
+                getMd5Digest = function (content) { return __awaiter(void 0, void 0, void 0, function () {
+                    var md5Hasher;
+                    return __generator(this, function (_a) {
+                        md5Hasher = new md5_js_1.Md5();
+                        md5Hasher.update((0, utils_1.utf8Encode)(content));
+                        return [2 /*return*/, md5Hasher.digest()];
+                    });
+                }); };
+                _a = exports.assignStringVariables;
+                _e = {
+                    'x-amz-server-side-encryption-customer-algorithm': input.SSECustomerAlgorithm,
+                    // base64 encoded is need
+                    // see: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#specifying-s3-c-encryption
+                    'x-amz-server-side-encryption-customer-key': input.SSECustomerKey && (0, utils_1.toBase64)(input.SSECustomerKey)
+                };
+                // Calculate the md5 digest of the the SSE-C key, for compatibility with AWS SDK
+                // see: https://github.com/aws/aws-sdk-js-v3/blob/91fc83307c38cc9cbe0b3acd919557d5b5b831d6/packages/middleware-ssec/src/index.ts#L36
+                _b = 'x-amz-server-side-encryption-customer-key-md5';
+                _c = input.SSECustomerKey;
+                if (!_c) return [3 /*break*/, 2];
+                _d = utils_1.toBase64;
+                return [4 /*yield*/, getMd5Digest(input.SSECustomerKey)];
+            case 1:
+                _c = _d.apply(void 0, [_f.sent()]);
+                _f.label = 2;
+            case 2: return [2 /*return*/, _a.apply(void 0, [(
+                    // Calculate the md5 digest of the the SSE-C key, for compatibility with AWS SDK
+                    // see: https://github.com/aws/aws-sdk-js-v3/blob/91fc83307c38cc9cbe0b3acd919557d5b5b831d6/packages/middleware-ssec/src/index.ts#L36
+                    _e[_b] = _c,
+                        _e)])];
+        }
+    });
+}); };
+exports.serializeObjectSsecOptionsToHeaders = serializeObjectSsecOptionsToHeaders;
+/**
+ * Serailize the parameters for configuring the S3 object. Currently used by
+ * `putObject` and `createMultipartUpload` API.
+ *
+ * @internal
+ */
+var serializeObjectConfigsToHeaders = function (input) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a;
+    var _b;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                _a = [{}];
+                return [4 /*yield*/, (0, exports.serializeObjectSsecOptionsToHeaders)(input)];
+            case 1: return [2 /*return*/, (__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_c.sent())])), (0, exports.assignStringVariables)(__assign({ 'x-amz-server-side-encryption': input.ServerSideEncryption, 'x-amz-server-side-encryption-aws-kms-key-id': input.SSEKMSKeyId, 'x-amz-acl': input.ACL, 'cache-control': input.CacheControl, 'content-disposition': input.ContentDisposition, 'content-language': input.ContentLanguage, 'content-encoding': input.ContentEncoding, 'content-type': input.ContentType, expires: (_b = input.Expires) === null || _b === void 0 ? void 0 : _b.toUTCString(), 'x-amz-tagging': input.Tagging }, serializeMetadata(input.Metadata)))]))];
+        }
+    });
+}); };
+exports.serializeObjectConfigsToHeaders = serializeObjectConfigsToHeaders;
+var serializeMetadata = function (metadata) {
+    if (metadata === void 0) { metadata = {}; }
+    return Object.keys(metadata).reduce(function (acc, suffix) {
+        acc["x-amz-meta-".concat(suffix.toLowerCase())] = metadata[suffix];
+        return acc;
+    }, {});
+};
+/**
+ * Serialize the object key to a URL pathname.
+ * @see https://github.com/aws/aws-sdk-js-v3/blob/7ed7101dcc4e81038b6c7f581162b959e6b33a04/clients/client-s3/src/protocols/Aws_restXml.ts#L1108
+ *
+ * @internal
+ */
+var serializePathnameObjectKey = function (url, key) {
+    return (url.pathname.replace(/\/$/, '') +
+        "/".concat(key.split('/').map(aws_client_utils_1.extendedEncodeURIComponent).join('/')));
+};
+exports.serializePathnameObjectKey = serializePathnameObjectKey;

package/lib/Storage.d.ts

@@ -10,11 +10,11 @@ export declare class Storage {
     private _pluggables;
     /**
      * Similar to the API module. This weak map allows users to cancel their in-flight request made using the Storage
-     * module. For every get or put request, a unique cancel token will be generated and injected to it's underlying
-     * AxiosHttpHandler. This map maintains a mapping of Request to CancelTokenSource. When .cancel is invoked, it will
-     * attempt to retrieve it's corresponding cancelTokenSource and cancel the in-flight request.
+     * module. For every get or put request, a unique AbortConttroller will be generated and injected to it's underlying
+     * Xhr HTTP handler. This map maintains a mapping of Request to AbortController. When .cancel is invoked, it will
+     * attempt to retrieve it's corresponding abortController and cancel the in-flight request.
      */
-    private _cancelTokenSourceMap;
+    private _abortControllerMap;
     /**
      * @public
      */
@@ -46,7 +46,7 @@ export declare class Storage {
      * @return {Object} - Current configuration
      */
     configure(config?: any): any;
-    private getCancellableTokenSource;
+    private getAbortController;
     private updateRequestToBeCancellable;
     private isUploadTask;
     /**

package/lib/Storage.js

@@ -1,11 +1,38 @@
 "use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
+exports.StorageInstance = exports.Storage = void 0;
 var core_1 = require("@aws-amplify/core");
 var providers_1 = require("./providers");
-var axios_1 = tslib_1.__importDefault(require("axios"));
+var utils_1 = require("./AwsClients/S3/utils");
 var AWSS3UploadTask_1 = require("./providers/AWSS3UploadTask");
 var logger = new core_1.ConsoleLogger('StorageClass');
 var loggerStorageInstance = new core_1.ConsoleLogger('Storage'); // Logging relating to Storage instance management
@@ -21,7 +48,7 @@ var Storage = /** @class */ (function () {
     function Storage() {
         this._config = {};
         this._pluggables = [];
-        this._cancelTokenSourceMap = new WeakMap();
+        this._abortControllerMap = new WeakMap();
         logger.debug('Storage Options', this._config);
         this.get = this.get.bind(this);
         this.put = this.put.bind(this);
@@ -75,7 +102,7 @@ var Storage = /** @class */ (function () {
         logger.debug('configure Storage');
         if (!config)
             return this._config;
-        var amplifyConfig = core_1.parseAWSExports(config);
+        var amplifyConfig = (0, core_1.parseAWSExports)(config);
         var storageConfig = (_a = amplifyConfig.Storage) !== null && _a !== void 0 ? _a : {};
         var defaultProviderConfigKeys = [
             'bucket',
@@ -86,6 +113,7 @@ var Storage = /** @class */ (function () {
             'serverSideEncryption',
             'SSECustomerAlgorithm',
             'SSECustomerKey',
+            // TODO(AllanZhengYP): remove in V6.
             'SSECustomerKeyMD5',
             'SSEKMSKeyId',
         ];
@@ -97,7 +125,7 @@ var Storage = /** @class */ (function () {
             storageConfig[DEFAULT_PROVIDER] = {};
         }
         Object.entries(storageConfig).forEach(function (_a) {
-            var _b = tslib_1.__read(_a, 2), key = _b[0], value = _b[1];
+            var _b = __read(_a, 2), key = _b[0], value = _b[1];
             if (key &&
                 defaultProviderConfigKeys.includes(key) &&
                 value !== undefined) {
@@ -108,7 +136,7 @@ var Storage = /** @class */ (function () {
         // only update new values for each provider
         Object.keys(storageConfig).forEach(function (providerName) {
             if (typeof storageConfig[providerName] !== 'string') {
-                _this._config[providerName] = tslib_1.__assign(tslib_1.__assign({}, _this._config[providerName]), storageConfig[providerName]);
+                _this._config[providerName] = __assign(__assign({}, _this._config[providerName]), storageConfig[providerName]);
             }
         });
         this._pluggables.forEach(function (pluggable) {
@@ -119,11 +147,11 @@ var Storage = /** @class */ (function () {
         }
         return this._config;
     };
-    Storage.prototype.getCancellableTokenSource = function () {
-        return axios_1.default.CancelToken.source();
+    Storage.prototype.getAbortController = function () {
+        return new AbortController();
     };
-    Storage.prototype.updateRequestToBeCancellable = function (request, cancelTokenSource) {
-        this._cancelTokenSourceMap.set(request, cancelTokenSource);
+    Storage.prototype.updateRequestToBeCancellable = function (request, abortController) {
+        this._abortControllerMap.set(request, abortController);
     };
     Storage.prototype.isUploadTask = function (x) {
         return (typeof x !== 'undefined' &&
@@ -134,9 +162,11 @@ var Storage = /** @class */ (function () {
         if (request instanceof AWSS3UploadTask_1.AWSS3UploadTask) {
             return request._cancel();
         }
-        var cancelTokenSource = this._cancelTokenSourceMap.get(request);
-        if (cancelTokenSource) {
-            cancelTokenSource.cancel(message);
+        var abortController = this._abortControllerMap.get(request);
+        if (abortController) {
+            // TODO: [v6] clean up the aborted promise in the weak map.
+            // Not doing it yet to avoid breaking changes when users may abort a request twice.
+            abortController.abort(message);
         }
         else {
             logger.debug('The request does not map to any cancel token');
@@ -149,12 +179,12 @@ var Storage = /** @class */ (function () {
             logger.debug('No plugin found with providerName', provider);
             return Promise.reject('No plugin found in Storage for the provider');
         }
-        var cancelTokenSource = this.getCancellableTokenSource();
+        var abortController = this.getAbortController();
         if (typeof plugin.copy !== 'function') {
-            return Promise.reject(".copy is not implemented on provider " + plugin.getProviderName());
+            return Promise.reject(".copy is not implemented on provider ".concat(plugin.getProviderName()));
         }
-        var responsePromise = plugin.copy(src, dest, tslib_1.__assign(tslib_1.__assign({}, config), { cancelTokenSource: cancelTokenSource }));
-        this.updateRequestToBeCancellable(responsePromise, cancelTokenSource);
+        var responsePromise = plugin.copy(src, dest, __assign(__assign({}, config), { abortSignal: abortController.signal }));
+        this.updateRequestToBeCancellable(responsePromise, abortController);
         return responsePromise;
     };
     Storage.prototype.get = function (key, config) {
@@ -164,13 +194,13 @@ var Storage = /** @class */ (function () {
             logger.debug('No plugin found with providerName', provider);
             return Promise.reject('No plugin found in Storage for the provider');
         }
-        var cancelTokenSource = this.getCancellableTokenSource();
-        var responsePromise = plugin.get(key, tslib_1.__assign(tslib_1.__assign({}, config), { cancelTokenSource: cancelTokenSource }));
-        this.updateRequestToBeCancellable(responsePromise, cancelTokenSource);
+        var abortController = this.getAbortController();
+        var responsePromise = plugin.get(key, __assign(__assign({}, config), { abortSignal: abortController.signal }));
+        this.updateRequestToBeCancellable(responsePromise, abortController);
         return responsePromise;
     };
     Storage.prototype.isCancelError = function (error) {
-        return axios_1.default.isCancel(error);
+        return (0, utils_1.isCancelError)(error);
     };
     Storage.prototype.getProperties = function (key, config) {
         var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
@@ -179,12 +209,12 @@ var Storage = /** @class */ (function () {
             logger.debug('No plugin found with providerName', provider);
             throw new Error('No plugin found with providerName');
         }
-        var cancelTokenSource = this.getCancellableTokenSource();
+        var abortController = this.getAbortController();
         if (typeof plugin.getProperties !== 'function') {
-            return Promise.reject(".getProperties is not implemented on provider " + plugin.getProviderName());
+            return Promise.reject(".getProperties is not implemented on provider ".concat(plugin.getProviderName()));
         }
-        var responsePromise = plugin === null || plugin === void 0 ? void 0 : plugin.getProperties(key, tslib_1.__assign({}, config));
-        this.updateRequestToBeCancellable(responsePromise, cancelTokenSource);
+        var responsePromise = plugin === null || plugin === void 0 ? void 0 : plugin.getProperties(key, __assign({}, config));
+        this.updateRequestToBeCancellable(responsePromise, abortController);
         return responsePromise;
     };
     Storage.prototype.put = function (key, object, config) {
@@ -194,10 +224,10 @@ var Storage = /** @class */ (function () {
             logger.debug('No plugin found with providerName', provider);
             return Promise.reject('No plugin found in Storage for the provider');
         }
-        var cancelTokenSource = this.getCancellableTokenSource();
-        var response = plugin.put(key, object, tslib_1.__assign(tslib_1.__assign({}, config), { cancelTokenSource: cancelTokenSource }));
+        var abortController = this.getAbortController();
+        var response = plugin.put(key, object, __assign(__assign({}, config), { abortSignal: abortController.signal }));
         if (!this.isUploadTask(response)) {
-            this.updateRequestToBeCancellable(response, cancelTokenSource);
+            this.updateRequestToBeCancellable(response, abortController);
         }
         return response;
     };
@@ -236,11 +266,11 @@ var getInstance = function () {
     var old_configure = _instance.configure;
     _instance.configure = function (options) {
         loggerStorageInstance.debug('storage configure called');
-        var vaultConfig = tslib_1.__assign({}, old_configure.call(_instance, options));
+        var vaultConfig = __assign({}, old_configure.call(_instance, options));
         // set level private for each provider for the vault
         Object.keys(vaultConfig).forEach(function (providerName) {
             if (typeof vaultConfig[providerName] !== 'string') {
-                vaultConfig[providerName] = tslib_1.__assign(tslib_1.__assign({}, vaultConfig[providerName]), { level: 'private' });
+                vaultConfig[providerName] = __assign(__assign({}, vaultConfig[providerName]), { level: 'private' });
             }
         });
         loggerStorageInstance.debug('storage vault configure called');
@@ -250,4 +280,3 @@ var getInstance = function () {
 };
 exports.StorageInstance = getInstance();
 core_1.Amplify.register(exports.StorageInstance);
-//# sourceMappingURL=Storage.js.map

package/lib/common/S3ClientUtils.d.ts

@@ -1,38 +1,47 @@
 /// <reference types="node" />
 import { ICredentials, StorageAction } from '@aws-amplify/core';
+import type { Credentials as AwsCredentials } from '@aws-sdk/types';
+import type { EventEmitter } from 'events';
 import { StorageAccessLevel, CustomPrefix } from '../types';
-import { InitializeMiddleware, InitializeHandlerOptions, FinalizeRequestHandlerOptions, FinalizeRequestMiddleware } from '@aws-sdk/types';
-import { S3ClientConfig, S3Client } from '@aws-sdk/client-s3';
-import { CancelTokenSource } from 'axios';
-import * as events from 'events';
 export declare const getPrefix: (config: {
     credentials: ICredentials;
     level?: StorageAccessLevel;
     customPrefix?: CustomPrefix;
     identityId?: string;
 }) => string;
-export declare const createPrefixMiddleware: (opt: Record<string, any>, key: string) => InitializeMiddleware<any, any>;
-export declare const autoAdjustClockskewMiddleware: (config: S3ClientConfig) => FinalizeRequestMiddleware<any, any>;
-export declare const autoAdjustClockskewMiddlewareOptions: FinalizeRequestHandlerOptions;
-export declare const prefixMiddlewareOptions: InitializeHandlerOptions;
 export declare const credentialsProvider: () => Promise<{
     accessKeyId: any;
     sessionToken: any;
     secretAccessKey: any;
     identityId: any;
     authenticated: any;
-} | {
-    accessKeyId: string;
-    secretAccessKey: string;
 }>;
-export declare const createS3Client: (config: {
+interface S3InputConfig {
+    credentials?: AwsCredentials;
     region?: string;
-    cancelTokenSource?: CancelTokenSource;
-    dangerouslyConnectToHttpEndpointForTesting?: boolean;
     useAccelerateEndpoint?: boolean;
-}, storageAction: StorageAction, emitter?: events.EventEmitter) => S3Client;
+    abortSignal?: AbortSignal;
+    emitter?: EventEmitter;
+    storageAction: StorageAction;
+    dangerouslyConnectToHttpEndpointForTesting?: boolean;
+}
+export interface S3ResolvedConfig extends Omit<S3InputConfig, 'region' | 'credentials'> {
+    region: string;
+    userAgentValue?: string;
+    credentials: () => Promise<AwsCredentials>;
+    customEndpoint?: string;
+    forcePathStyle?: boolean;
+}
+/**
+ * A function that persists the s3 configs, so we don't need to
+ * assign each config parameter for every s3 API call.
+ *
+ * @inernal
+ */
+export declare const loadS3Config: (config: S3InputConfig) => S3ResolvedConfig;
 export declare const DEFAULT_PART_SIZE: number;
 export declare const MAX_OBJECT_SIZE: number;
 export declare const MAX_PARTS_COUNT = 10000;
 export declare const DEFAULT_QUEUE_SIZE = 4;
 export declare const calculatePartSize: (totalSize: number) => number;
+export {};